Visit Rightsline
logo
Powered by Redocly

Download Endpoints

Download a specific Contact Attachment.

Download a specific Contact Attachment.

You can get the Download URL for each Contact Attachment from the _downloadUrl property in the contactAttachments collection for each Contact.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Contact Attachment Unique Identity. You can obtain the Unique Identity values for the Contact Attachments from the contactAttachments collection when you submit the GET /api/data/contacts/{guid} endpoint for a Contact.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/contactAttachments/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific Contract Attachment.

Download a specific Contract Attachment.

You can get the Download URL for each Contract Attachment from the _downloadUrl property in the contractAttachments collection for each Contract.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Contract Attachment Unique Identity. You can obtain the Unique Identity values for the Contract Attachments from the contractAttachments collection when you submit the GET /api/data/contracts/{guid} endpoint for a Contract.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/contractAttachments/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific Deal Attachment.

Download a specific Deal Attachment.

You can get the Download URL for each Deal Attachment from the _downloadUrl property in the dealAttachments collection for each Deal.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Deal Attachment Unique Identity. You can obtain the Unique Identity values for the Deal Attachments from the dealAttachments collection for a Deal in the deals collection when you submit the GET /api/data/contracts/{guid} endpoint for a Contract.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/dealAttachments/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific IP Right Attachment.

Download a specific IP Right Attachment.

You can get the Download URL for each IP Right Attachment from the _downloadUrl property in the ipRightAttachments collection for each IP Right.

SecurityHeaderToken
Request
path Parameters
guid
required
string

IP Right Attachment Unique Identity. You can obtain the Unique Identity values for the IP Right Attachments from the ipRightAttachments collection when you submit the GET /api/data/ipRights/{guid} endpoint for an IP Right.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/ipRightAttachments/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific IP Rights Template Right Attachment.

Download a specific IP Rights Template Right Attachment.

You can get the Download URL for each IP Right Template Right Attachment from the _downloadUrl property in the ipRightTemplateRightAttachments collection for each IP Right Template Right.

SecurityHeaderToken
Request
path Parameters
guid
required
string

IP Right Template Right Attachment Unique Identity. You can obtain the Unique Identity values for the IP Right Template Right Attachments from the ipRightTemplateRightAttachments collection for an IP Right Template Right in the ipRightTemplateRights collection when you submit the GET /api/data/ipRightsEntryTemplateHeaders/{guid} endpoint for an IP Rights Template.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/ipRightTemplateRightAttachments/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific Note Attachment.

Download a specific Note Attachment.

You can get the Download URL for each Note Attachment from the _downloadUrl property in the noteAttachments collection in the associated Notes collection for each Item, when applicable.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Note Attachment Unique Identity. You can obtain the Unique Identity values for the Note Attachments from the noteAttachments collection for a Note in the XXNotes collection when you submit the GET endpoint for an Item.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/noteAttachment/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific Statement.

Download a specific Statement.

You can get the Download URL for a Statement Result from the _downloadUrl property when you GET the information for a Statement Result Summary.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Statement Result Summary Unique Identity. You can obtain the Unique Identity values for the Statement Result Summaries from the guid property when you submit the GET /api/data/statementResultSummaries endpoint.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/statementResultSummary/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}

Download a specific Transaction Characteristic Item Attachment

Download a specific Transaction Characteristic Item Attachment.

You can get the Download URL for each Transaction Characteristic Item Attachment from the _downloadUrl property in the userXAttachments collection for each Transaction Characteristic Item.

Note: This endpoint description applies to all 20 user-customizible Transaction Characteristics (User1-User20). Make sure that you replace UserX or udKeyX with the appropriate Transaction Characteristic value in the endpoint URI and property names (for example, User1 or udKey1).

SecurityHeaderToken
Request
path Parameters
guid
required
string

Transaction Characteristic Item Attachment Unique Identity. You can obtain the Unique Identity values for the Transaction Characteristic Item Attachments from the userXAttachments collection when you submit the GET /api/data/userX/{guid} endpoint for a Transaction Characteristic Item.

query Parameters
autoLogOff
boolean

Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes.

header Parameters
Accept
required
string

You must include an Accept HTTP Header with the value set to application/octet-stream.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/download/userXAttachments/{guid}
Response samples
application/json
{
  • "errors": [
    ],
  • "hasErrors": true,
  • "hasWarnings": true,
  • "result": null,
  • "warnings": [
    ]
}
➔ Next to IP Rights