ObjectMetadata
ObjectMetadata Service
Web service endpoints for providing metadata about object types known to the system.
Get All Object Metadata
GET /metadata/objects/@allReturn object type metadata about all defined object types in a single response. Add
fields=@all query parameter if you want to include the fields
and resourceLinks information; otherwise, they will be omitted.
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
Get Field Metadata
GET /metadata/objects/{name}/{field}Return field metadata about the specified field of the specified object type.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | Name of the requested object type |
| field | String | true | Name of the requested field |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | if the specified object type or field name is missing |
| (Not Found) | if the specified object type or field name is not valid |
Get Field Metadata Values
GET /metadata/objects/{name}/{field}/valuesReturn the first 25 field values for the specified field of the specified object type.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | Name of the requested object type |
| field | String | true | Name of the requested field |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| filter | String[] | false | One or more filters. Valid filters are "search" and "fieldValues". |
| count | Integer | false | Maximum number of values to be returned (i.e. the page size) |
| includeCount | Boolean | false | Return a count of a given value. Count is given where possible as part of the field value. |
| objectValues | Boolean | false | Return values as objects, in this form {value: |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | if the specified object type or field name is missing |
| (Not Found) | if the specified object type or field name is not valid |
Get Object Metadata
GET /metadata/objects/{name}Return object type metadata about the specified object type, and the fields it contains.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | Name of the requested object type |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | if the specified name is missing |
| (Not Found) | if the specified name does not match a known object type |
Get Object Metadata Values
GET /metadata/objects/{name}/valuesReturn the first 25 field values for each specified field of the specified object type.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | Name of the requested object type |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String[] | false | Names of the requested fields. If not specified, all fields with values are returned. |
| filter | String[] | false | One or more filters. Valid filters are "search" and "fieldValues". |
| count | Integer | false | Maximum number of values to be returned (i.e. the page size) |
| includeCount | Boolean | false | Return a count of a given value. Return a count of a given value. Count is given where possible as part of the field value. |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | if the specified object type or field name is missing |
| (Not Found) | if the specified object type or field name is not valid |
Get Object Types
GET /metadata/objectsReturn a mapping of known object type names to the URI to use to retrieve the details about that object type
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |