Skip to main content Skip to complementary content

Get details of an entity by its name

Availability-noteDeprecated

Gets details of an entity by its name, including the ID (name) of the data model in which the entity is created.

Information noteNote: Only the Super Admin type users with the administration role have access to this API. For more information about MDM user types, see MDM user types and system roles.
Request 
GET /services/rest/system/models/entities/{entityName}
Parameters
  • entityName: This is a String value which specifies the name of the entity.
Headers
  • Accept: application/json
  • Authorization: Basic Authentication scheme
Response The details of the entity in JSON format.
Status
  • 200 OK: The operation is executed successfully.
  • 401 UNAUTHORIZED: Login fails, invalid username or password.
  • 403 FORBIDDEN: Missing required permission.
  • 404 NOT FOUND: The resource does not exist, for example, invalid entity name.
  • 500 INTERNAL SERVER ERROR: Other errors.

Sample response

{
  "dataModelId": "Product",
  "entity": "Product"
}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here