Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Attribute Lookup REST APIs
GET /lookup/{organizationId}/attributes
Description
Gets all the attributes (properties) for the given Organization ID.
URL
/lookup/{organizationId}/attributes
Method
GET
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization |
Responses
| Code | Response |
|---|---|
200 | ◊ Attributes for the given Organization ID. { "data": [ { "name": "Location", "values": [ "Boston", "NY", "Pasadena" ], "id": "5a58faabd4131828ab9dbdc1", "organizationId": 888409690212728, "lastUpdatedBy": "xyz", "lastUpdatedOn": "2018-01-12T18:12:59.602Z" }, { "name": "Group Type", "values": [ "Accountable team", "Informedf", "Resolver" ], "id": "5a58fccdd4131828ab9dbdcb", "organizationId": 888409690212728, "lastUpdatedBy": "xyz", "lastUpdatedOn": "2018-01-12T18:22:05.437Z" }, { "name": "Product", "values": [ "Dell", "Hardware", "Oracle", "SQL" ], "id": "5a986e36d41318563766e021", "organizationId": 888409690212728, "lastUpdatedBy": "xyz", "lastUpdatedOn": "2018-03-01T21:18:46.914Z" }, . . . ] } |
◊ No attributes available for the given Organization ID. { "data": [] } | |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } ◊ No organization access to the User. { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } |
POST /lookup/{organizationId}/attributes
Description
Creates a new attribute (property) for the given Organization ID.
URL
/lookup/{organizationId}/attributes
Method
POST
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization |
Request Body
Responses
| Code | Response |
|---|---|
200 | ◊ Created LookupAttribute object. { "data": { "name": "Team", "values": [ "ATLAS", "IPAAS", "ITA", "RME", "SaaS Ops", "SRE" ], "id": "5aabcf8ed413187489146a33", "organizationId": 888409690212728, "lastUpdatedBy": "Paulomi Mahidharia", "lastUpdatedOn": "2018-03-16T14:07:10.035Z" } } |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } |
400 | ◊ Empty/Null attribute name and values passes in Request Body. { "errors": [ { "codes": [ "NotNull.resourceObject.data.name", "NotNull.data.name", "NotNull.name", "NotNull.java.lang.String", "NotNull" ], "arguments": [ { "codes": [ "resourceObject.data.name", "data.name" ], "defaultMessage": "data.name", "code": "data.name" } ], "defaultMessage": "may not be null", "objectName": "resourceObject", "field": "data.name", "bindingFailure": false, "code": "NotNull" }, { "codes": [ "NotNull.resourceObject.data.values", "NotNull.data.values", "NotNull.values", "NotNull.java.util.Set", "NotNull" ], "arguments": [ { "codes": [ "resourceObject.data.values", "data.values" ], "defaultMessage": "data.values", "code": "data.values" } ], "defaultMessage": "may not be null", "objectName": "resourceObject", "field": "data.values", "bindingFailure": false, "code": "NotNull" }, |
{ "codes": [ "NotEmpty.resourceObject.data.name", "NotEmpty.data.name", "NotEmpty.name", "NotEmpty.java.lang.String", "NotEmpty" ], "arguments": [ { "codes": [ "resourceObject.data.name", "data.name" ], "defaultMessage": "data.name", "code": "data.name" } ], "defaultMessage": "may not be empty", "objectName": "resourceObject", "field": "data.name", "bindingFailure": false, "code": "NotEmpty" }, { "codes": [ "NotEmpty.resourceObject.data.values", "NotEmpty.data.values", "NotEmpty.values", "NotEmpty.java.util.Set", "NotEmpty" ], "arguments": [ { "codes": [ "resourceObject.data.values", "data.values" ], "defaultMessage": "data.values", "code": "data.values" } ], "defaultMessage": "may not be empty", "objectName": "resourceObject", "field": "data.values", "bindingFailure": false, "code": "NotEmpty" } ] } | |
◊ Attribute already exists { "errors": [ { "defaultMessage": "Attribute name already exists", "objectName": "com.everbridge.ita.lookup.model.LookupAttribute", "field": "name", "bindingFailure": false } ] } |
GET /lookup/{organizationId}/attributes/{attributeId}
Description
Gets all the attribute (property) for the given Organization ID and Attribute ID.
URL
/lookup/{organizationId}/attributes/{attributeId}
Method
GET
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization. |
attributeId | Yes | String | - | The ID of the attribute. |
Responses
| Code | Response |
|---|---|
200 | ◊ LookupAttribute object. { "data": { "name": "Teams", "values": [ "ATLAS", "IPAAS", "ITA", "RME", "SaaS Ops" ], "id": "5aabcf8ed413187489146a33", "organizationId": 888409690212728, "lastUpdatedBy": "Paulomi Mahidharia", "lastUpdatedOn": "2018-03-16T14:50:45.139Z" } } |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } ◊ No organization access to the User. { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } |
404 | ◊ Incorrect attribute ID passed. // No response body |
PUT /lookup/{organizationId}/attributes/{attributeId}
Description
Updates the attribute (property) for the given Organization ID and Attribute ID.
URL
/lookup/{organizationId}/attributes/{attributeId}
Method
PUT
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization. |
attributeId | Yes | String | - | The ID of the attribute. |
Request Body
Responses
| Code | Response |
|---|---|
200 | ◊ Updated LookupAttribute object. { "data": { "name": "Teams", "values": [ "ATLAS", "IPAAS", "ITA", "RME", "SaaS Ops" ], "id": "5aabcf8ed413187489146a33", "organizationId": 888409690212728, "lastUpdatedBy": "Paulomi Mahidharia", "lastUpdatedOn": "2018-03-16T14:50:45.139Z" } } |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } ◊ No organization access to the User. { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } |
400 | ◊ Empty/Null attribute name and values passed in Request Body.. { "errors": [ { "codes": [ "NotNull.resourceObject.data.name", "NotNull.data.name", "NotNull.name", "NotNull.java.lang.String", "NotNull" ], "arguments": [ { "codes": [ "resourceObject.data.name", "data.name" ], |
"defaultMessage": "data.name", "code": "data.name" } ], "defaultMessage": "may not be null", "objectName": "resourceObject", "field": "data.name", "bindingFailure": false, "code": "NotNull" }, { "codes": [ "NotNull.resourceObject.data.values", "NotNull.data.values", "NotNull.values", "NotNull.java.util.Set", "NotNull" ], "arguments": [ { "codes": [ "resourceObject.data.values", "data.values" ], "defaultMessage": "data.values", "code": "data.values" } ], "defaultMessage": "may not be null", "objectName": "resourceObject", "field": "data.values", "bindingFailure": false, "code": "NotNull" }, { "codes": [ "NotEmpty.resourceObject.data.name", "NotEmpty.data.name", "NotEmpty.name", "NotEmpty.java.lang.String", "NotEmpty" ], "arguments": [ { { "codes": [ "resourceObject.data.name", "data.name" ], "defaultMessage": "data.name", "code": "data.name" } | |
], "defaultMessage": "may not be empty", "objectName": "resourceObject", "field": "data.name", "bindingFailure": false, "code": "NotEmpty" }, { "codes": [ "NotEmpty.resourceObject.data.values", "NotEmpty.data.values", "NotEmpty.values", "NotEmpty.java.util.Set", "NotEmpty" ], "arguments": [ { "codes": [ "resourceObject.data.values", "data.values" ], "defaultMessage": "data.values", "code": "data.values" } ], "defaultMessage": "may not be empty", "objectName": "resourceObject", "field": "data.values", "bindingFailure": false, "code": "NotEmpty" } ] } | |
404 | ◊ Incorrect attribute ID passed. // No response body |
DELETE /lookup/{organizationId}/attributes/{attributeId}
Description
Deletes and existing attribute for the given Organization ID and Attribute ID.
URL
/lookup/{organizationId}/attributes/{attributeId}
Method
DELETE
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization. |
attributeId | Yes | String | - | The ID of the attribute. |
Responses
| Code | Response |
|---|---|
200 | ◊ Attribute deleted successfully. { "data": "Attribute was deleted successfully" } |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } ◊ No organization access to the User. { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } |
], "defaultMessage": "may not be empty", "objectName": "resourceObject", "field": "data.name", "bindingFailure": false, "code": "NotEmpty" }, { "codes": [ "NotEmpty.resourceObject.data.values", "NotEmpty.data.values", "NotEmpty.values", "NotEmpty.java.util.Set", "NotEmpty" ], "arguments": [ { "codes": [ "resourceObject.data.values", "data.values" ], "defaultMessage": "data.values", "code": "data.values" } ], "defaultMessage": "may not be empty", "objectName": "resourceObject", "field": "data.values", "bindingFailure": false, "code": "NotEmpty" } ] } | |
404 | ◊ Incorrect attribute ID passed. // No response body |
GET /lookup/{organizationId}/attributes/searchByName?attributeName={attributeName}
Description
Gets the attribute (property) for the given Organization ID and Attribute Name.
URL
/lookup/{organizationId}/attributes/searchName?attributeName={atrributeName}
Method
GET
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization. |
attributeName | Yes | String | - | The name of the attribute. |
Responses
| Code | Response |
|---|---|
200 | ◊ Updated LookupAttribute object. { "data": { "name": "Teams", "values": [ "ATLAS", "IPAAS", "ITA", "RME", "SaaS Ops" ], "id": "5aabcf8ed413187489146a33", "organizationId": 888409690212728, "lastUpdatedBy": "Paulomi Mahidharia", "lastUpdatedOn": "2018-03-16T14:50:45.139Z" } } |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } ◊ No organization access to the User. { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } |
404 | ◊ Incorrect/non-existing attribute name passed. // No response body |
GET /lookup/{organizationId}/attributes/searchByNameAndValue?attributeName={attributeName}&value={attributeValue}¤tPageNo={currentPageNo}&pageSize={pageSize}
Description
Gets the attribute (property) for the given Organization ID and Attribute Name.
URL
/lookup/{organizationId}/attributes/searchByName
Method
GET
URL Parameters
| Parameter | Mandatory | Type | Default Value | Description |
|---|---|---|---|---|
organizationId | Yes | Long | - | The ID of the organization. |
attributeName | Yes | String | - | The name of the attribute. |
attributeValue | No | String | One of the values of the attribute. | |
currentPageNo | No | int | 1 | Page number used to scroll through the mapping records. |
pageSize | No | int | 50 | Number of mapping records on the page. |
Responses
| Code | Response |
|---|---|
200 | ◊ Correct Attribute Name and Value(s) passed. { "currentPageNo": 1, "totalPageCount": 0, "totalCount": 3, "pageSize": 50, "data": [ "Boston", "NY", "Pasadena" ] } ◊ Incorrect Attribute Name and/or Value(s) passed. { "currentPageNo": 1, "totalPageCount": 0, "totalCount": 3, "pageSize": 50, "data": [] } |
401 | ◊ Invalid JWT access token. { "code": 401, "message": "Unauthorized" } ◊ No organization access to the User. { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } |