Entity search

Search for an entity or set of entities based on their characteristics.

The entity search object

{
  "keywords": "string",
  "query": {},
  "start": 0,
  "rows": 10,
  "cursorToken": "string",
  "sortOrders": [
    "string"
  ],
  "parentQuery": {},
  "childQuery": {}
}

Entity search

POST https://ris.rightsline.com/v4/:entityType/search

This endpoint allows you to search for entities based on specific criteria.

Path Parameters

Name	Type	Description
entityType	string	The type of entity to search for. ex. deal, catalog-item, table, etc.

Headers

Name	Type	Description
x-api-key	string	Your company's API key.
Authentication	string	Authentication token.

Query Parameters

Name	Type	Description
extendedData	boolean (optional)	If true, returns Extended Characteristics in the response.

Request Body

Name	Type	Description
query	object	The search query to match the entity.
childQuery	object	The search query to match the child of the entity.
parentQuery	object	The search query to match the parent of the entity.

200 A result set of entities matching the search query.

{
  "numFound": 1,
  "entities": [
    {
      "id": 44,
      "revisionId": 0,
      "title": "Rights In",
      "template": {
        "fields": [],
        "templateId": 1,
        "templateName": "Rights In",
        "processId": 0,
        "processName": null
      },
      "status": {
        "statusId": 1,
        "statusName": "Active"
      },
      "characteristics": {
        "media_right": [
          {
            "id": 2,
            "value": "All Media"
          }
        ],
        "actual_term_start": "2020-02-25",
        "territory": [
          {
            "id": 1,
            "value": "Worldwide"
          }
        ],
        "actual_term_end": "2020-02-27",
        "language": [
          {
            "id": 4,
            "value": "All Languages"
          }
        ],
        "exclusivity": {
          "id": 2,
          "value": "Non-Exclusive"
        }
      },
      "comments": null,
      "createdById": 1,
      "createdDate": "2019-05-30T22:35:07.337Z",
      "lastUpdatedById": 1,
      "lastUpdatedDate": "2019-09-05T03:35:52.950Z"
    }
  ]
}