Links

Create a batch

post
https://ris.rightsline.com
/v4/batch
Create batch

Sample Create Batch request - Retrieve records

{
"method": "GET",
"batchOptions": {
"cancelIfRecordFails": false
},
"records": {
"1": [
{
"id": 100
},
{
"id": 101
}
],
"3": [
{
"id": 200
},
{
"id": 201
}
]
},
"relationships": [
{
"id": 301
}
]
}

Sample Create Batch Request - Create contact records

{
"method": "POST",
"records": {
"2": [
{
"title":"Person 1",
"template":{
"templateId": 1
},
"characteristics":{
"first_name": "John",
"last_name": "Smith",
"department": "Sales"
}
},
{
"title":"Person 2",
"template":{
"templateId": 1
},
"characteristics":{
"first_name": "Susan",
"last_name": "Williams",
"department": "Accounting"
}
}
]
},
"batchOptions":{
"cancelIfRecordFails": true
}
}

Sample Create Batch Request - Copy Record

{
"method": "COPY",
"records": {
"2": [
{
"copyRelationships": [
{
"id": 971252653,
"relationshipType": {
"relationshipTypeId": 0,
"relationshipTypeName": "Default"
},
"parentCharTypeId": 4,
"parentRecordId": 4123,
"parentTemplate": {
"templateId": 1,
},
"childCharTypeId": 2,
"childRecordId": 402
}
],
"title":"New Title of Record",
"id": 402,
"template":{
"templateId": 1
}
}
]
},
"batchOptions":{
"cancelIfRecordFails": true
}
}

Sample Create Batch Request - Copy To

The Copy To functionality allows you to copy records to a new char type. The request is the same as the Copy functionality, but including the new charTypeId and the new templateId for the copied record.
{
"method": "COPY",
"records": {
"2": [
{
"copyRelationships": [
{
"id": 971252653,
"relationshipType": {
"relationshipTypeId": 0,
"relationshipTypeName": "Default"
},
"parentCharTypeId": 4,
"parentRecordId": 4123,
"parentTemplate": {
"templateId": 1,
},
"childCharTypeId": 2,
"childRecordId": 402
}
],
"charTypeId": 4,
"title":"New Title of Record",
"id": 402,
"template":{
"templateId": 12
},
"characteristics":{
"first_name": "John",
"last_name": "Smith",
"department": "Sales"
}
}
]
},
"batchOptions":{
"cancelIfRecordFails": true
}
}

Sample Create Batch Request - Execute Workflow

{
"method": "EXECUTE-WORKFLOW",
"records": {
"1": [
{
"id": 100,
"actionId": 1
},
{
"id": 101,
"actionId": 1
}
],
"3": [
{
"id": 200,
"actionId": 2
},
{
"id": 201,
"actionId": 4
}
]
}
}

Sample Create Batch Request - Create Relationship

{
"method": "POST",
"relationships": [
{
"parentCharTypeId": 4,
"parentRecordId": 4156,
"childCharTypeId": 3,
"childRecordId": 131262
},
{
"parentCharTypeId": 4,
"parentRecordId": 4156,
"childCharTypeId": 3,
"childRecordId": 131604
},
{
"parentCharTypeId": 4,
"parentRecordId": 4156,
"childCharTypeId": 3,
"childRecordId": 1324213
}
]
}

Sample Create Batch Request - Calculate Amortization

{
"method": "CALCULATE-AMORTIZATION",
"amortizationModelId": 1,
"records": {
"5": [
{
"id": 200
},
{
"id": 201
}
]
}
}