### Get Template List (JSON Response Example)

Source: https://api-docs.rightsline.com/config/templates

This snippet shows an example JSON response for retrieving a list of templates for a given entity type. It includes template IDs, names, group information, and associated process details. This response is typically returned when successfully querying the template list endpoint.

```json
{
    "templates": [
        {
            "templateId": 14,
            "templateName": "Bundle/Pack",
            "templateGroupId": 2,
            "templateGroupName": "Collection",
            "systemIndicatorId": 0,
            "processId": 4,
            "processName": "Catalog Workflow"
        },
        {
            "templateId": 12,
            "templateName": "Series",
            "templateGroupId": 1,
            "templateGroupName": "Property",
            "systemIndicatorId": 0,
            "processId": 4,
            "processName": "Catalog Workflow"
        }
    ]
}
```

--------------------------------

### Paginated Search Request in C#

Source: https://api-docs.rightsline.com/search/pagination/making-paginated-search-requests

This C# example demonstrates how to perform paginated search requests. It iteratively calls a search function, accumulating results and adjusting the 'start' parameter until all records (indicated by 'numFound') are retrieved. It assumes the existence of SearchRequest, Entity, and SendSearchRequest function.

```csharp
public IEnumerable<Entity> SendPaginatedSearchRequest(SearchRequest request)
{
    var entities = new List<Entity>();
    bool isAdditionalRecords = true;
    
    while(isAdditionalRecords)
    {
        var result = SendSearchRequest(request);
        entities.AddRange(result.Entities);
        
        if (request.Start + request.Rows < result.NumFound)
        {
            // Additional records to retrieve. Increment start by rows.
            request.Start += request.Rows;
        }
        else
        {
            // All records have been retrieved.
            isAdditionalRecords = false;
        }
    }
    return entities;
}
```

--------------------------------

### Get Deal Workflow Processes (JavaScript Example)

Source: https://api-docs.rightsline.com/entities/deal/retrieve-deal-processes

This snippet demonstrates how to retrieve deal workflow processes using the Rightsline API. It requires an API key and an authentication token in the headers. The response is a JSON object containing a list of deal processes.

```javascript
{
    "processes": [
        {
            "processId": 5,
            "processName": "Deal Workflow",
            "sequenceNumber": 1,
            "description": "Deal Workflow Description"
        },
        {
            "processId": 26,
            "processName": "Production Deal Workflow",
            "sequenceNumber": 2,
            "description": "Production Deal Workflow Description"
        }
    ]
}
```

--------------------------------

### Contact Creation Response Examples

Source: https://api-docs.rightsline.com/entities/contact/contact-create

These examples show the expected responses from the Rightsline API after attempting to create a contact. The first example shows a successful creation, returning the new contact's ID. The second example illustrates an error response when required information, such as 'TemplateId', is missing.

```json
100
```

```json
{
  "message": "TemplateId is required"
}
```

--------------------------------

### Retrieve Financial Periods Settings (JavaScript Example)

Source: https://api-docs.rightsline.com/financial/financial-periods/get-financial-periods-settings

This snippet demonstrates a successful retrieval of financial periods settings using a JavaScript array. It shows the structure of the response, including process names, IDs, and associated action details. No external dependencies are required for this client-side representation.

```javascript
[
    {
        "processName": "Amount Workflow",
        "processId": 8,
        "actionId": 8,
        "actionName": "Deactivate, Make Not Deletable, Lock"
    },
    {
        "processName": "Locked Amounts Post-release",
        "processId": 38,
        "actionId": 2,
        "actionName": "Go to the Locked Status"
    },
    {
        "processName": "Advance Payment Workflow",
        "processId": 64,
        "actionId": null,
        "actionName": null
    },
    {
        "processName": "Sub-Allocation Workflow",
        "processId": 77,
        "actionId": null,
        "actionName": null
    }
]
```

--------------------------------

### Paginate Parties for an Entity (GraphQL)

Source: https://api-docs.rightsline.com/graphql/entity/parties

Demonstrates how to paginate through party records for an entity using 'skip' and 'take' parameters. This is essential for managing large datasets and improving API response times. The example shows fetching records starting from the 11th record and taking 10.

```graphql
{
    entity(id: 10, charTypeId: 4) {
       parties(skip: 10, take: 10) {
            items {
                 id
                 title
                 partyId
                 partyName
            }
       }
    }
}
```

--------------------------------

### GET /v4/snapshots/{guid}

Source: https://api-docs.rightsline.com/avails/avails-dimension-data-2

Retrieves the details of a specific snapshot identified by its GUID.

```APIDOC
## GET /v4/snapshots/{guid}

### Description
This endpoint returns a snapshot's details.

### Method
GET

### Endpoint
`https://ris.rightsline.com/v4/snapshots/{guid}`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the snapshot.

### Response
#### Success Response (200)
- **associatedCatalog** (object) - Information about the associated catalog.
  - **id** (integer) - The catalog's ID.
  - **title** (string) - The catalog's title.
  - **template** (object) - Details about the catalog's template.
    - **templateId** (integer) - The template's ID.
    - **templateName** (string) - The template's name.
    - **templateGroupId** (integer) - The template group ID.
    - **systemIndicatorId** (integer) - The system indicator ID.
    - **processId** (integer) - The process ID.
  - **status** (object) - The status of the catalog.
    - **statusId** (integer) - The status ID.
    - **statusName** (string) - The status name.
- **media** (array) - A list of associated media types.
  - **id** (integer) - The media type ID.
  - **value** (string) - The media type name.
- **territory** (array) - A list of associated territories.
  - **id** (integer) - The territory ID.
  - **value** (string) - The territory name.
- **language** (array) - A list of associated languages.
  - **id** (integer) - The language ID.
  - **value** (string) - The language name.
- **channel** (array) - A list of associated channels.
  - **id** (integer) - The channel ID.
  - **value** (string) - The channel name.
- **termStart** (string) - The start date of the term (ISO 8601 format).
- **termEnd** (string) - The end date of the term (ISO 8601 format).
- **exclusivity** (boolean) - Indicates if the snapshot has exclusivity.

#### Response Example
```json
[
    {
        "associatedCatalog": {
            "id": 43222,
            "title": "01.26 Episode 105",
            "template": {
                "templateId": 13,
                "templateName": "Episode",
                "templateGroupId": 0,
                "systemIndicatorId": 0,
                "processId": 0
            },
            "status": {
                "statusId": 1,
                "statusName": "Development"
            }
        },
        "media": [
            {
                "id": 10,
                "value": "Theatrical"
            }
        ],
        "territory": [
            {
                "id": 186,
                "value": "France"
            }
        ],
        "language": [
            {
                "id": 38,
                "value": "French"
            }
        ],
        "channel": [
            {
                "id": 2,
                "value": "Apple TV"
            },
            {
                "id": 3,
                "value": "Google Play"
            }
        ],
        "termStart": "2025-01-02T00:00:00.000Z",
        "termEnd": "2025-01-29T00:00:00.000Z",
        "exclusivity": true
    }
]
```
```

--------------------------------

### Create Project

Source: https://api-docs.rightsline.com/entities

Creates a new project. This endpoint is used to initiate new projects with their initial details and configurations.

```text
POST /entities/project/project-create.md
```

--------------------------------

### Get Available Catalog Items - Response Example (JSON)

Source: https://api-docs.rightsline.com/avails/available-catalog-items

This JSON object represents a successful response (200 OK) from the 'Get available catalog items' endpoint. It includes the total row count and an array of catalog items, each with its ID, status, template details, and title.

```json
{
    "rowCount": 2,
    "rows": [
        {
            "id": 100,
            "status": {
                "statusId": 2,
                "statusName": "Packaging/Financing"
            },
            "template": {
                "processId": 0,
                "processName": null,
                "templateId": 1,
                "templateName": "Feature"
            },
            "title": "Title 1"
        },
        {
            "id": 101,
            "status": {
                "statusId": 1,
                "statusName": "Development"
            },
            "template": {
                "processId": 0,
                "processName": null,
                "templateId": 1,
                "templateName": "Feature"
            },
            "title": "Title 2"
        }
    ]
}
```

--------------------------------

### SSO Overview

Source: https://api-docs.rightsline.com/sso

Provides an overview of the three basic endpoints for SSO configuration.

```APIDOC
## Overview

This section provides an overview of the Single Sign-On (SSO) configuration endpoints.

### Method
GET

### Endpoint
/sso/overview.md

### Description
Retrieves an overview of the available SSO configuration endpoints.

### Response
#### Success Response (200)
- **endpoints** (array) - A list of available SSO configuration endpoints.
```

--------------------------------

### Get Available Catalog Items - Request Body Example (JSON)

Source: https://api-docs.rightsline.com/avails/available-catalog-items

This JSON object demonstrates a sample request body for the 'Get available catalog items' endpoint. It includes dimension filters, date ranges, matching types, pagination settings, and specific IDs for templates, statuses, and characteristics.

```json
{
  "dim1": [6],
  "dim2": [43],
  "dim3": [29],
  "dim4": [], 
  "windowStart": "2021-10-01", 
  "windowEnd": "2021-10-31",   
  "isExclusive": false,
  "matchType": "CoverEntire",
  "isExact": false,
  "start": 0,   
  "rows": 25,
  "templateIds": [1,2],
  "statusIds": [1],
  "characteristics":{
      "genre":["Adventure"]
  },
  "rightTemplateIds":[2,4]
}
```

--------------------------------

### Successful Project Creation Response Example (Integer)

Source: https://api-docs.rightsline.com/entities/project/project-create

Example of a successful response when a project is created. The response returns the integer ID of the newly created project.

```text
14462
```

--------------------------------

### Create Project Request Body Example (JSON)

Source: https://api-docs.rightsline.com/entities/project/project-create

Example of a JSON request body for creating a project. It includes the project title, template details, and characteristics. Ensure all required fields are present and correctly formatted.

```json
{
  "title": "New Project Title",
  "template": {
    "templateId": 123
  },
  "characteristics": {
    "customField1": "value1",
    "customField2": "value2"
  },
  "parentRelationship": [
    {
      "entityId": 456,
      "relationshipType": "parent"
    }
  ]
}
```

--------------------------------

### Get User Applications - Success Response (JSON)

Source: https://api-docs.rightsline.com/users/get-applications

This is an example of a successful response (200 OK) when retrieving user applications. The response is a JSON array, where each object represents an application with its ID, name, URL, and URL type ID.

```json
[
    {
        "id": 24,
        "name": "Some Company",
        "url": "https://admin.rightsline.com/",
        "urlTypeId": "3"
    },
    {
        "id": 45,
        "name": "UX2 - Some Company",
        "url": "https://app.rightsline.com/",
        "urlTypeId": "4"
    }
]
```

--------------------------------

### Common Error Codes and Handling

Source: https://api-docs.rightsline.com/overview/errors

A guide to common HTTP status codes returned by the API, their descriptions, and recommended actions to resolve them.

```APIDOC
## Common Error Codes

Our API bindings can raise exceptions for many reasons, such as invalid parameters, authentication errors, and network unavailability. We recommend always trying to gracefully handle exceptions from our API.

| Error Code | Description           | How to fix                                                                                                                                                                                                      |
| ---------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400        | Bad Request           | A message will be returned in the response with details on how to modify your request.                                                                                                                          |
| 401        | Unauthorized          | Verify your credentials and authorization signature is correct.                                                                                                                                                 |
| 403        | Permission Denied     | Verify you have the correct permissions enabled in Rightsline to access/create the record.                                                                                                                      |
| 404        | Not Found             | Modify the ID of the record you are attempting to read/update/delete.                                                                                                                                           |
| 429        | Too Many Requests     | The Rightsline API has daily and per-second limits. Retry the request after a 1 second delay. If error persists, you may have reached your daily limit.                                                              |
| 500        | Internal Server Error | Contact Rightsline Support.                                                                                                                                                                                     |
| 503        | Service Unavailable   | During UAT, you may receive this error when a new build is being deployed to one of the UAT environments. Simply retry the request after a few minutes.                                                              |
| 504        | Gateway Timeout       | If attempting to create/update record, try to retrieve the record. If record was not created/updated, retry the request. If attempting to retrieve temporary credentials or a record, simply retry the request. |
```

--------------------------------

### Get Amount Statuses - Example Response (JavaScript)

Source: https://api-docs.rightsline.com/entities/amount/retrieve-amount-statuses

This snippet shows a successful response from the GET /v4/amount-statuses/{templateId} endpoint. It returns a list of amount statuses, each with an ID and a name. This data can be used to understand the different states an amount can be in within the system.

```javascript
{
    "statuses": [
        {
            "statusId": 1,
            "statusName": "Amount Created"
        },
        {
            "statusId": 2,
            "statusName": "Added to Billing Document"
        },
        {
            "statusId": 3,
            "statusName": "Amount Paid"
        },
        {
            "statusId": 4,
            "statusName": "Amount Cancelled"
        },
        {
            "statusId": 5,
            "statusName": "Inactive, Deletable, Unlocked"
        },
        {
            "statusId": 6,
            "statusName": "Active, Not Deletable, Locked"
        },
        {
            "statusId": 7,
            "statusName": "Inactive, Not Deletable, Locked"
        },
        {
            "statusId": 9,
            "statusName": "Approved"
        },
        {
            "statusId": 10,
            "statusName": "Active, Deletable, Locked"
        }
    ]
}
```

--------------------------------

### Get Inventory Statuses (JavaScript Example)

Source: https://api-docs.rightsline.com/entities/inventory/retrieve-inventory-statuses

This JavaScript code snippet demonstrates a successful retrieval of inventory statuses. It shows the structure of the JSON response, including status IDs and names. This example assumes a successful API call and focuses on the response payload.

```javascript
{
    "statuses": [
        {
            "statusId": 1,
            "statusName": "Created"
        },
        {
            "statusId": 2,
            "statusName": "Solicited"
        },
        {
            "statusId": 3,
            "statusName": "QC Required"
        },
        {
            "statusId": 4,
            "statusName": "Checked In"
        },
        {
            "statusId": 6,
            "statusName": "Checked Out"
        },
        {
            "statusId": 8,
            "statusName": "QC Rejected"
        },
        {
            "statusId": 5,
            "statusName": "Deprecated"
        },
        {
            "statusId": 7,
            "statusName": "Inactive, Deletable, Unlocked"
        },
        {
            "statusId": 9,
            "statusName": "Active, Not Deletable, Locked"
        },
        {
            "statusId": 10,
            "statusName": "Inactive, Not Deletable, Locked"
        }
    ]
}
```

--------------------------------

### Full Entity Object Structure Example (JavaScript)

Source: https://api-docs.rightsline.com/entities/the-entity-object

A comprehensive example illustrating the complete structure of an entity object, including parent relationships, template details, status, characteristics, and comments.

```javascript
{
  "parentRelationship": [
    {
      "id": 0,
      "parentTemplate": {
        "templateId": 0,
        "templateName": "string"
      },
      "parentStatus": {
        "statusId": 0,
        "statusName": "string"
      },
      "childTemplate": {
        "templateId": 0,
        "templateName": "string"
      },
      "childStatus": {
      "statusId": 0,
        "statusName": "string"
      },
      "relationshipType": {
        "relationshipTypeId": 0,
        "relationshipTypeName": "string"
      },
      "createdById": 0,
      "createdDate": "2020-06-04T19:39:02.584Z",
      "lastUpdatedById": 0,
      "lastUpdatedDate": "2020-06-04T19:39:02.584Z",
      "parentCharTypeId": 0,
      "parentRecordId": 0,
      "childCharTypeId": 0,
      "childRecordId": 0,
      "sequenceNumber": 0
    }
  ],
  "parentRelationshipCount": 0,
  "id": 0,
  "revisionId": 0,
  "title": "string",
  "template": {
    "fields": [
      {
        "fieldName": "string",
        "label": "string",
        "required": true,
        "maxLength": 0,
        "editable": true,
        "dataType": "string",
        "allowMultiple": true,
        "listOfValues": [
          {
            "id": 0,
            "label": "string",
            "xref": "string",
            "childValues": [
              {}
            ]
          }
        ]
      }
    ],
    "templateId": 0,
    "templateName": "string",
    "processId": 0,
    "processName": "string"
  },
  "status": {
    "statusId": 0,
    "statusName": "string"
  },
  "characteristics": {},
  "characteristicsExtended": {},
  "comments": [
    {
      "parentID": 0,
      "id": 0,
      "userID": 0,
      "userName": "string",
      "userEmail": "string",
      "profileAvatar": "string",
      "entityID": "string",
      "text": "string",
      "created": "2020-06-04T19:39:02.584Z",
      "updated": "2020-06-04T19:39:02.584Z",
      "children": [
        {}
      ]
    }
  ],
  "createdById": 0,
  "createdDate": "2020-06-04T19:39:02.584Z",
  "lastUpdatedById": 0,
  "lastUpdatedDate": "2020-06-04T19:39:02.584Z",
  "statusUpdatedById": 0,
  "statusUpdatedDate": "2020-06-04T19:39:02.584Z"
}
```

--------------------------------

### Get Dimension Data (JavaScript Example)

Source: https://api-docs.rightsline.com/avails/avails-dimension-data

This snippet demonstrates the structure of the JSON response when successfully retrieving availability dimension data. It includes nested lists for various dimensions like media, geography, and language. The response format is consistent for a 200 OK status.

```javascript
{
	"dim1":[
		{
			"id":75,
			"label":"All Media",
			"xref":null,
			"childListItems":[
				{
					"id":16,
					"label":"Linear",
					"xref":null,
					"childListItems":[
						...
					]
				},
				...
			]
		}
	],
	"dim2":[
		{
			"id":1,
			"label":"World",
			"xref":null,
			"childListItems":[
				{
					"id":45,
					"label":"Europe",
					"xref":null,
					"childListItems":[
						...
					]
				},
				...
			]
		}
	],
	"dim3":[
		{
			"id":1,
			"label":"All Languages",
			"xref":null,
			"childListItems":[
				{
					"id":4,
					"label":"Afghan/Pashtu",
					"xref":null
				},
				{
					"id":2,
					"label":"Afrikaans",
					"xref":null
				},
				...
			]
		}
	],
	"dim4":[
		...
	]
}
```

--------------------------------

### Entity Object Structure Example

Source: https://api-docs.rightsline.com/entities/the-entity-object

Provides a full example of the entity object structure, including all potential fields and nested objects.

```APIDOC
## Entity Object Structure Example

```json
{
  "parentRelationship": [
    {
      "id": 0,
      "parentTemplate": {
        "templateId": 0,
        "templateName": "string"
      },
      "parentStatus": {
        "statusId": 0,
        "statusName": "string"
      },
      "childTemplate": {
        "templateId": 0,
        "templateName": "string"
      },
      "childStatus": {
      "statusId": 0,
        "statusName": "string"
      },
      "relationshipType": {
        "relationshipTypeId": 0,
        "relationshipTypeName": "string"
      },
      "createdById": 0,
      "createdDate": "2020-06-04T19:39:02.584Z",
      "lastUpdatedById": 0,
      "lastUpdatedDate": "2020-06-04T19:39:02.584Z",
      "parentCharTypeId": 0,
      "parentRecordId": 0,
      "childCharTypeId": 0,
      "childRecordId": 0,
      "sequenceNumber": 0
    }
  ],
  "parentRelationshipCount": 0,
  "id": 0,
  "revisionId": 0,
  "title": "string",
  "template": {
    "fields": [
      {
        "fieldName": "string",
        "label": "string",
        "required": true,
        "maxLength": 0,
        "editable": true,
        "dataType": "string",
        "allowMultiple": true,
        "listOfValues": [
          {
            "id": 0,
            "label": "string",
            "xref": "string",
            "childValues": [
              {}
            ]
          }
        ]
      }
    ],
    "templateId": 0,
    "templateName": "string",
    "processId": 0,
    "processName": "string"
  },
  "status": {
    "statusId": 0,
    "statusName": "string"
  },
  "characteristics": {},
  "characteristicsExtended": {},
  "comments": [
    {
      "parentID": 0,
      "id": 0,
      "userID": 0,
      "userName": "string",
      "userEmail": "string",
      "profileAvatar": "string",
      "entityID": "string",
      "text": "string",
      "created": "2020-06-04T19:39:02.584Z",
      "updated": "2020-06-04T19:39:02.584Z",
      "children": [
        {}
      ]
    }
  ],
  "createdById": 0,
  "createdDate": "2020-06-04T19:39:02.584Z",
  "lastUpdatedById": 0,
  "lastUpdatedDate": "2020-06-04T19:39:02.584Z",
  "statusUpdatedById": 0,
  "statusUpdatedDate": "2020-06-04T19:39:02.584Z"
}
```
```

--------------------------------

### Get Relationship Types - API Response Example (JavaScript)

Source: https://api-docs.rightsline.com/relationships/relationship-types

This snippet shows a successful response from the GET /v4/relationship-types endpoint. It returns a JSON object containing an array of relationship types, each with an ID and a name. This data can be used to understand and utilize the different ways entities can be related within Rightsline.

```javascript
{
  "relationshipTypes": [
    {
      "relationshipTypeId": 0,
      "relationshipTypeName": "Default"
    },
    {
      "relationshipTypeId": 14,
      "relationshipTypeName": "Department"
    },
    {
      "relationshipTypeId": 3,
      "relationshipTypeName": "Responsible Party"
    },
    {
      "relationshipTypeId": 24,
      "relationshipTypeName": "Watcher"
    },
    {
      "relationshipTypeId": 2,
      "relationshipTypeName": "Contracting Party"
    },
    {
      "relationshipTypeId": 1,
      "relationshipTypeName": "Counterparty"
    },
    {
      "relationshipTypeId": 15,
      "relationshipTypeName": "Representative"
    },
    {
      "relationshipTypeId": 17,
      "relationshipTypeName": "As Relates To"
    },
    {
      "relationshipTypeId": 23,
      "relationshipTypeName": "Sales Rep"
    },
    {
      "relationshipTypeId": 6,
      "relationshipTypeName": "Submitted By"
    },
    {
      "relationshipTypeId": 30,
      "relationshipTypeName": "Submitted To"
    },
    {
      "relationshipTypeId": 12,
      "relationshipTypeName": "Reviewer"
    },
    {
      "relationshipTypeId": 29,
      "relationshipTypeName": "Coverage By"
    },
    {
      "relationshipTypeId": 5,
      "relationshipTypeName": "Recipient"
    },
    {
      "relationshipTypeId": 13,
      "relationshipTypeName": "Financier"
    },
    {
      "relationshipTypeId": 20,
      "relationshipTypeName": "Executive Producer"
    },
    {
      "relationshipTypeId": 11,
      "relationshipTypeName": "Producer"
    },
    {
      "relationshipTypeId": 10,
      "relationshipTypeName": "Actor"
    },
    {
      "relationshipTypeId": 8,
      "relationshipTypeName": "Writer"
    },
    {
      "relationshipTypeId": 9,
      "relationshipTypeName": "Director"
    },
    {
      "relationshipTypeId": 26,
      "relationshipTypeName": "Director of Photography"
    },
    {
      "relationshipTypeId": 25,
      "relationshipTypeName": "Editor"
    },
    {
      "relationshipTypeId": 27,
      "relationshipTypeName": "Music Supervisor"
    },
    {
      "relationshipTypeId": 28,
      "relationshipTypeName": "Crew"
    },
    {
      "relationshipTypeId": 16,
      "relationshipTypeName": "Delivery"
    },
    {
      "relationshipTypeId": 21,
      "relationshipTypeName": "Location"
    },
    {
      "relationshipTypeId": 4,
      "relationshipTypeName": "Payment"
    },
    {
      "relationshipTypeId": 22,
      "relationshipTypeName": "MISC/OTHER"
    },
    {
      "relationshipTypeId": 31,
      "relationshipTypeName": "Legal"
    },
    {
      "relationshipTypeId": 32,
      "relationshipTypeName": "Marketing"
    },
    {
      "relationshipTypeId": 33,
      "relationshipTypeName": "Seller"
    },
    {
      "relationshipTypeId": 34,
      "relationshipTypeName": "Buyer"
    },
    {
      "relationshipTypeId": 35,
      "relationshipTypeName": "Viewers v2"
    },
    {
      "relationshipTypeId": 39,
      "relationshipTypeName": "Production Company"
    },
    {
      "relationshipTypeId": 40,
      "relationshipTypeName": "Executive"
    },
    {
      "relationshipTypeId": 41,
      "relationshipTypeName": "Creator"
    },
    {
      "relationshipTypeId": 42,
      "relationshipTypeName": "Host"
    },
    {
      "relationshipTypeId": 43,
      "relationshipTypeName": "Talent"
    }
  ]
}
```

--------------------------------

### Batch Requests Overview

Source: https://api-docs.rightsline.com/batch/overview

This section provides an overview of how batch requests work, including their asynchronous nature and the use of batch IDs for status monitoring.

```APIDOC
## Batch Requests

### Description
Batch requests allow you to process multiple records within a single API request. Batch processing is completed asynchronously, so when a batch is created, a batch ID will be returned in the response, and this batch ID can be queried periodically to determine the batch's status.

### Method
POST (for creating a batch)
GET (for querying batch status)

### Endpoint
`/batches` (example for creation)
`/batches/{batchId}` (example for status query)

### Parameters
#### Query Parameters (for status query)
- **batchId** (string) - Required - The unique identifier for the batch operation.

### Request Example (Creating a Batch)
```json
{
  "operations": [
    {
      "method": "POST",
      "path": "/users",
      "body": {
        "name": "John Doe",
        "email": "john.doe@example.com"
      }
    },
    {
      "method": "PUT",
      "path": "/users/123",
      "body": {
        "status": "active"
      }
    }
  ]
}
```

### Response (Creating a Batch)
#### Success Response (202 Accepted)
- **batchId** (string) - The unique identifier for the created batch operation.

#### Response Example (Creating a Batch)
```json
{
  "batchId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response (Querying Batch Status)
#### Success Response (200 OK)
- **status** (string) - The current status of the batch (e.g., "pending", "processing", "completed", "failed").
- **results** (array) - An array of results for each operation within the batch, if completed or failed.

#### Response Example (Querying Batch Status)
```json
{
  "status": "completed",
  "results": [
    {
      "status": 201,
      "body": {
        "id": "user-1"
      }
    },
    {
      "status": 200,
      "body": {
        "message": "User updated successfully"
      }
    }
  ]
}
```
```

--------------------------------

### GET /v3/currency/conversion/list

Source: https://api-docs.rightsline.com/config/currency-conversion-sept-16

Retrieves all currency conversions. This endpoint provides a list of all configured currency conversion rates.

```APIDOC
## GET /v3/currency/conversion/list

### Description
Retrieves all currency conversions. This endpoint provides a list of all configured currency conversion rates.

### Method
GET

### Endpoint
/v3/currency/conversion/list

### Response
#### Success Response (200)
- **conversions** (array) - A list of currency conversion objects.
  - Each object contains:
    - **id** (string) - The unique identifier for the currency conversion.
    - **from_currency** (string) - The currency code to convert from.
    - **to_currency** (string) - The currency code to convert to.
    - **rate** (number) - The conversion rate.

#### Response Example
```json
{
  "conversions": [
    {
      "id": "conv_123abc",
      "from_currency": "USD",
      "to_currency": "EUR",
      "rate": 0.85
    },
    {
      "id": "conv_456def",
      "from_currency": "EUR",
      "to_currency": "USD",
      "rate": 1.18
    }
  ]
}
```
```

--------------------------------

### Get Snapshot Details (JavaScript Example)

Source: https://api-docs.rightsline.com/avails/avails-dimension-data-2

This snippet demonstrates the structure of the response when retrieving details for a specific snapshot using the Rightsline API. It outlines the associated catalog information, media, territory, language, channel, term dates, and exclusivity status. This data is returned as a JSON array of snapshot objects.

```javascript
[
    {
        "associatedCatalog": {
            "id": 43222,
            "title": "01.26 Episode 105",
            "template": {
                "templateId": 13,
                "templateName": "Episode",
                "templateGroupId": 0,
                "systemIndicatorId": 0,
                "processId": 0
            },
            "status": {
                "statusId": 1,
                "statusName": "Development"
            }
        },
        "media": [
            {
                "id": 10,
                "value": "Theatrical"
            }
        ],
        "territory": [
            {
                "id": 186,
                "value": "France"
            }
        ],
        "language": [
            {
                "id": 38,
                "value": "French"
            }
        ],
        "channel": [
            {
                "id": 2,
                "value": "Apple TV"
            },
            {
                "id": 3,
                "value": "Google Play"
            }
        ],
        "termStart": "2025-01-02T00:00:00.000Z",
        "termEnd": "2025-01-29T00:00:00.000Z",
        "exclusivity": true
    }
]
```

--------------------------------

### Example API Request Object

Source: https://api-docs.rightsline.com/avails/avails-get-availability

This JSON object represents a typical request to the API. It includes parameters for record identification, dimension filtering, date windows, matching criteria, pagination, and display options. Note that some parameters like 'isExclusive' and 'isExact' have default values if not explicitly provided.

```json
{
"recordId": [
      36816
  ],
  "dim1": [],
  "dim2": [],
  "dim3": [],
  "dim4": [],
  "windowStart": "2021-10-01",
  "windowEnd": "2021-10-31",
  "isExclusive": false,
  "matchType": "CoverEntire",
  "isExact": false,
  "start": 0,
  "rows": 25,
  "includeUserFriendlyDimensionDisplay": true,
  "rightsActions":[
    {
        "reasonUnavailable": "RightsOutExist",
        "rightsActionsTemplateIds":[2],
        "showDimensionLimitation": true,
        "showTermLimitation": true
    }
  ]
}
```

--------------------------------

### Get Contact Workflow Processes (JavaScript Example)

Source: https://api-docs.rightsline.com/entities/contact/retrieve-contact-processes

This JavaScript code snippet demonstrates a successful response when retrieving contact workflow processes. It shows the structure of the JSON object containing a list of processes, each with its ID, name, sequence number, and description. This is typically returned after a successful GET request to the /v4/contact-processes endpoint.

```javascript
{
    "processes": [
        {
            "processId": 2,
            "processName": "Contact Workflow",
            "sequenceNumber": 1,
            "description": "Contact Workflow Description"
        }
    ]
}
```

--------------------------------

### Workflow Actions Response (JSON)

Source: https://api-docs.rightsline.com/workflow/get-workflow-actions

Example JSON response when successfully retrieving workflow actions. The response contains a list of actions, each with its ID, name, description, initial status flag, sequence number, and resulting status.

```json
{
    "actions": [
        {
            "actionId": 1,
            "actionName": "Development",
            "actionDescription": "Development",
            "isInitialAction": true,
            "sequenceNumber": 1,
            "resultingStatus": "Development"
        },
        {
            "actionId": 2,
            "actionName": "Packaging/Financing",
            "actionDescription": "",
            "isInitialAction": false,
            "sequenceNumber": 2,
            "resultingStatus": "Packaging/Financing"
        }
    ]
}
```

--------------------------------

### Retrieve Project

Source: https://api-docs.rightsline.com/entities

Retrieves details of a specific project. This endpoint allows fetching metadata and information about an existing project.

```text
GET /entities/project/project-retrieve.md
```

--------------------------------

### Entity Template Example (JSON)

Source: https://api-docs.rightsline.com/entities/the-entity-object

Shows the structure of the template object, which defines an entity's characteristics and relationships. It includes template ID, name, and process details.

```json
{
  "template": {
    "templateId": 1,
    "templateName": "Feature",
    "processId": 0,
    "processName": "Catalog Process"
  }
}
```

--------------------------------

### Get Table Statuses (JavaScript Example)

Source: https://api-docs.rightsline.com/entities/table/retrieve-table-statuses

This snippet demonstrates how to retrieve table statuses from the Rightsline API. It requires a templateId as a path parameter and includes authentication headers. The response is a JSON object containing a list of statuses.

```javascript
{
    "statuses": [
        {
            "statusId": 1,
            "statusName": "Created"
        },
        {
            "statusId": 2,
            "statusName": "Operative"
        },
        {
            "statusId": 3,
            "statusName": "Inactive"
        },
        {
            "statusId": 4,
            "statusName": "Triggered"
        },
        {
            "statusId": 5,
            "statusName": "Active, Not Deletable, Locked"
        },
        {
            "statusId": 6,
            "statusName": "Active, Deletable, Locked"
        },
        {
            "statusId": 7,
            "statusName": "Active, Not Deletable, UnLocked"
        },
        {
            "statusId": 9,
            "statusName": "In Review"
        },
        {
            "statusId": 10,
            "statusName": "Approved"
        }
    ]
}
```

--------------------------------

### Create Deal

Source: https://api-docs.rightsline.com/entities/deal

Creates a new deal. This endpoint allows for the initialization of a new deal record within the system.

```APIDOC
## POST /v4/deal

### Description
Creates a new deal.

### Method
POST

### Endpoint
/v4/deal

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **deal** (object) - Required - The deal object to be created.

### Request Example
```json
{
  "deal": {
    "name": "Example Deal",
    "description": "This is a sample deal."
  }
}
```

### Response
#### Success Response (201 Created)
* **deal** (object) - The created deal object.

#### Response Example
```json
{
  "deal": {
    "id": "deal-123",
    "name": "Example Deal",
    "description": "This is a sample deal.",
    "createdAt": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Get Right Statuses (JavaScript Example)

Source: https://api-docs.rightsline.com/entities/right/retrieve-right-statuses

This snippet demonstrates how to retrieve right statuses from the Rightsline API. It requires a template ID and authentication headers. The response is a JSON object containing an array of status objects, each with an ID and name.

```javascript
{
    "statuses": [
        {
            "statusId": 1,
            "statusName": "Active"
        },
        {
            "statusId": 2,
            "statusName": "Active, Not Deletable, Locked"
        },
        {
            "statusId": 3,
            "statusName": "Active, Deletable, Locked"
        },
        {
            "statusId": 4,
            "statusName": "Active, Not Deletable, Unlocked"
        },
        {
            "statusId": 5,
            "statusName": "Inactive, Deletable, Locked"
        },
        {
            "statusId": 6,
            "statusName": "Inactive, Deletable, Unlocked"
        },
        {
            "statusId": 7,
            "statusName": "Inactive, Not Deletable, Unlocked"
        },
        {
            "statusId": 8,
            "statusName": "Inactive, Not Deletable, Locked"
        }
    ]
}
```

--------------------------------

### Example API Response for Fields

Source: https://api-docs.rightsline.com/config/fields

This JSON structure represents a successful response (HTTP 200) from the 'Get Fields' API endpoint. It details various fields available for an entity, including their 'fieldName', 'fieldDescription', 'label', 'dataType', and other configuration parameters like 'required', 'maxLength', and 'editable'.

```json
[
    {
        "fieldName": "Notes",
        "fieldDescription": "Notes",
        "label": "notes",
        "required": false,
        "reportIndicator": true,
        "maxLength": 500,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": 1096
    },
    {
        "fieldName": "Currency",
        "fieldDescription": "Currency",
        "label": "currency",
        "required": false,
        "reportIndicator": true,
        "maxLength": 10,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "pickListSourceId": "186364fa-5253-ed11-9485-0af1f058195a",
        "pickListSourceName": "Currency",
        "listOfValues": [],
        "systemIndicatorId": 8
    },
    {
        "fieldName": "Due Date",
        "fieldDescription": "Due Date",
        "label": "due_date",
        "required": false,
        "reportIndicator": true,
        "maxLength": 25,
        "editable": false,
        "dataType": "Date_US",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": 2009
    },
    {
        "fieldName": "Payment Date",
        "fieldDescription": "Payment Date",
        "label": "payment_date",
        "required": false,
        "reportIndicator": true,
        "maxLength": 25,
        "editable": false,
        "dataType": "Date_US",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": 0
    },
    {
        "fieldName": "Total",
        "fieldDescription": "Total",
        "label": "total",
        "required": false,
        "reportIndicator": true,
        "maxLength": 50,
        "editable": false,
        "dataType": "Currency",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": 9
    },
    {
        "fieldName": "Balance",
        "fieldDescription": "Balance",
        "label": "balance",
        "required": false,
        "reportIndicator": true,
        "maxLength": 50,
        "editable": false,
        "dataType": "Currency",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": 10
    },
    {
        "fieldName": "Invoice ID",
        "fieldDescription": "Invoice ID",
        "label": "entity_id",
        "required": false,
        "reportIndicator": true,
        "maxLength": 50,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": -1
    },
    {
        "fieldName": "Revision ID",
        "fieldDescription": "Revision ID",
        "label": "entity_revision_id",
        "required": false,
        "reportIndicator": true,
        "maxLength": 50,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": -1
    },
    {
        "fieldName": "Invoice Title",
        "fieldDescription": "Invoice Title",
        "label": "entity_title",
        "required": false,
        "reportIndicator": true,
        "maxLength": 5000,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": -1
    },
    {
        "fieldName": "Template",
        "fieldDescription": "Template",
        "label": "entity_template",
        "required": false,
        "reportIndicator": true,
        "maxLength": 1000,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": -1
    },
    {
        "fieldName": "Status",
        "fieldDescription": "Status",
        "label": "entity_status",
        "required": false,
        "reportIndicator": true,
        "maxLength": 1000,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": -1
    },
    {
        "fieldName": "Alpha Numeric Text",
        "fieldDescription": "",
        "label": "alpha_numeric_text",
        "required": false,
        "reportIndicator": true,
        "maxLength": 10000,
        "editable": false,
        "dataType": "AlphaNumericText",
        "allowMultiple": false,
        "listOfValues": [],
        "systemIndicatorId": 0
    },
    {
        "fieldName": "Alpha Numeric Text Single Select LOV",
        "fieldDescription": "",
        "label": "alpha_numeric_text_single_select_lov",

```

--------------------------------

### Create File

Source: https://api-docs.rightsline.com/entities

Creates a new file within the system. This endpoint is used to upload and register new files, potentially with initial metadata.

```text
POST /entities/file/file-create.md
```