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:
NameTypeRequiredDescription
nameStringtrueName of the requested object type
fieldStringtrueName of the requested field
Retrieves:
  • Resource
  • Return Status:
    HTTP Status CodeDescription
    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:
    NameTypeRequiredDescription
    nameStringtrueName of the requested object type
    Return Status:
    HTTP Status CodeDescription
    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/resources

    Return a mapping of known object type names that provide resource metadata to the URI to retrieve details about the resources for that object type.

    Takes:
  • the URI information for this request
  • Retrieves:
  • Map with keys as resource names, and values as URIs of metadata information about that name