ObjectMetadata

ObjectMetadata Service

Web service endpoints for providing metadata about object types known to the system.

Get All Object Metadata

GET /metadata/objects/@all

Return 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:
  • Object[]
    • Return Status:
    HTTP Status CodeDescription
    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:
    NameTypeRequiredDescription
    nameStringtrueName of the requested object type
    fieldStringtrueName of the requested field
    Retrieves:
  • Field describing the specified field
    • Return Status:
    HTTP Status CodeDescription
    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:
    NameTypeRequiredDescription
    nameStringtrueName of the requested object type
    Retrieves:
  • Object
    • Return Status:
    HTTP Status CodeDescription
    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 Types

    GET /metadata/objects

    Return a mapping of known object type names to the URI to use to retrieve the details about that object type

    Takes:
  • the URI information for this request
    • Retrieves:
  • Map with keys being object types and values being URIs for the corresponding object metadata
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful