ResourceMetadata
ResourceMetadata Service
Web service endpoints for providing metadata about available resource links for object types known to the system.
Get Field Resource Metadata
GET /metadata/resources/{name}/{field}Return the field metadata about the specified resource 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) | The specified object type or field name is missing |
| (Not Found) | The specified object type or field name is not valid |
Get Object Resource Metadata
GET /metadata/resources/{name}Return available resources metadata about the specified object type.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | true | Name of the requested object type |
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | The specified name is missing |
| (Not Found) | The specified name does not match a known object type that has resources metadata |
Get Object Type Mappings
GET /metadata/resourcesReturn a mapping of known object type names that provide resource metadata to the URI to retrieve details about the resources for that object type.