API Documentation
API Documentation
v3
Introduction
Overview
Getting started
🔑 Authentication
Requesting temporary credentials
Signing requests
🎬 Entities
Entity types
The entity object
Amount
Catalog item
Contact
Deal
File
Financial document
Inventory
Job
Rightset
Table
👬 Relationships
The relationship object
Relationship types
Create a relationship
Delete a relationship
🔎 Search
Entity search
Relationship search
Pagination
Search Functions
Search Examples
🧰 Workflow
Execute a workflow action
📆 Date Math
Overview
The date math object
Create date math
Retrieve date math
Update date math
Delete date math
🧮 AVAILS
Overview
Get dimension data
Get availability
Is catalog item available
Swagger
Message queue docs
Rightsline.com
Execute a workflow action
Workflow actions can be executed on a specific entity of any type.
put
Execute workflow action
https://api.rightsline.com
/v3/:entityType/:id/execute-workflow-action/:actionID
This endpoint allows you to execute a workflow action on an entity.
Request
Response
Request
Path Parameters
entityType
required
string
The type of entity to perform the workflow action on. ex: deal, catalog-item, financial-document, etc.
id
required
integer
ID of the entity to perform the action on.
actionID
required
integer
ID of the action to take.
Headers
x-api-key
required
string
Your company's API key.
Authentication
required
string
Authentication token.
Response
200: OK
Workflow action executed successfully.
true
​
Previous
Find financial document by parent financial document
Next - 📆 Date Math
Overview
Last updated
1 week ago