⚠

Important notice The Classic Experience will be sunset on Aug. 1. If you have questions, contact your Customer Success and Implementation Manager, Account Manager, or support@trustarc.com.

Contact Support

External Request Task Controller

createTaskAndSendEmail

Method	POST
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/tasks`
Headers	Authorization: `Bearer <access_token from 'Token Access' section>`
URL Parameters	`N/A`
Sample Request	{ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdById": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdDate": "1595824012.298", "description": "Task Description", "dueDate": "1595824012.298", "externalUserAssignees": [ { "email": "sample@test.com", "name": "Sample name" } ], "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itSystemIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "itSystemNames": [ "Sample System Name" ], "jiraExternalId": "samplejira.id", "modifiedDate": "1595824012.298", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "priority": "HIGH", "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "resolution": "Can’t find data", "status": "COMPLETE", "title": "Sample Unique Title", "type": "", "userAssigneeIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }
Sample Success Response	{ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdById": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... } Where: `response` - task object created `itSystemIds` - system ids from Data Inventory Hub
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

createFromTemplate

Method	POST
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/tasks/from-task-templates`
Headers	Authorization: `Bearer <access_token from 'Token Access' section>`
URL Parameters	Required Query Parameters
	Name	Value	Description
	`id`	string($uuid)	The `id`(UUID) is the ID of the request.
	`taskTemplateIds`	(body)	Array of task-template ids that tasks will be based on.
Sample Request	[ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ]
Sample Success Response	[ { "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdById": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... } ] Where: `response`- array of task object
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

updateTaskAndSendEmail

Method	PUT
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/tasks/{taskId}`
Headers	Authorization: `Bearer <access_token from 'Token Access' section>`
URL Parameters	`N/A`
Sample Request	{ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdById": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdDate": "1595824012.298", "description": "Task Description", "dueDate": "1595824012.298", "externalUserAssignees": [ { "email": "sample@test.com", "name": "Sample name" } ], "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itSystemIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "itSystemNames": [ "Sample System Name" ], "jiraExternalId": "samplejira.id", "modifiedDate": "1595824012.298", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "priority": "HIGH", "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "resolution": "Can’t find data", "status": "COMPLETE", "title": "Sample Unique Title", "type": "", "userAssigneeIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }
Sample Success Response	{ "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdById": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... } Where: `response` - task object created
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

getRequestTasks

Method	GET
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/{requestId}/tasks`
Headers	Authorization: `Bearer <access_token from 'Token Access' section>`
URL Parameters	Required Query Parameters
	Name	Value	Description
	`noParent`	boolean
	`parentId`	string($uuid)
	`title`	string
	`requestId`	Request ID	Request where the tasks will be fetched from.
	`page`	integer($int32)	Results page you want to retrieve (0…N).
	`size`	integer($int32)	Number of records per page.
	`sort`	array[string]	Sorting criteria in the format: property(,asc\|desc).Default sort order is ascending. Multiple sort criteria are supported.Example: createdDate,asc
Sample Request	`N/A`
Sample Success Response	{ "content": [ { "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "children": [ null ], "createdById": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdDate": "string", "description": "string", "dueDate": "string", "externalUserAssignees": [ { "email": "string", "name": "string" } ], "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "itSystemIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "itSystemNames": [ "string" ], "jiraExternalId": "string", "modifiedDate": "string", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "priority": "HIGH", "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "resolution": "string", "status": "COMPLETE", "title": "string", "type": "string", "userAssignees": [ { "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "firstName": "string", "fullName": "string", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastName": "string", "status": "Active", "username": "string" } ] } ], "empty": true, "first": true, "last": true, "number": 0, "numberOfElements": 0, "pageable": { "page": "string", "size": "string", "sort": [ "string" ] }, "size": 0, "sort": { "empty": true, "sorted": true, "unsorted": true }, "totalElements": 0, "totalPages": 0 } Where: `content` – list of task objects `numberOfElements` – number of elements in content `totalElements` – number of total elements in the database `number` – page number `size` –size from url parameter `itSystemIds` - system ids from Data Inventory Hub
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

getTaskAttachments

Method	GET
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/tasks/{taskId}/attachments`
Headers	Authorization: `Bearer <access_token from 'Token Access' section>`
URL Parameters	Required Query Parameters
	Name	Value	Description
	`taskId`	Task ID	Task where the attachments will be fetched from.
	`page`	integer($int32)	Results page you want to retrieve (0…N).
	`size`	integer($int32)	Number of records per page.
	`sort`	array[string]	Sorting criteria in the format: property(,asc\|desc)Example: createdDate,asc
Sample Request	`N/A`
Sample Success Response	{ "content": [{"id": "9023a7aa-cc33-481e-ba16-7cb30256ff98", ...}], "numberOfElements": "10", "totalElements": "99", "number": "0", "size": "10", } Where: `content` – list of attachment objects `numberOfElements` – number of elements in content `totalElements` – number of total elements in the database `number` – page number `size` –size from url parameter
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

uploadTaskAttachments

Method	POST
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/tasks/{taskId}/attachments`
Headers	Authorization: `Bearer <access_token from 'Token Access' section>`
URL Parameters	`N/A`
Sample Request	`file (formData)`
Sample Success Response	{ "id": "9023a7aa-cc33-481e-ba16-7cb30256ff98", "fileName": "Sample.txt" } Where: `id` – auto-generated attachment identifier `fileName` – filename of uploaded file
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

searchTaskAssignees

Method	GET
Prod URL	`https://irm.trustarc.com/server/api/v1/external/requests/tasks/assignees/search`
Headers	Authorization: Bearer <access_token from 'Token Access' section>
URL Parameters	Required Query Parameters
	Name	Value	Description
	`name`	string	Search query by name
	`page`	integer($int32)	Results page you want to retrieve (0…N).
	`size`	integer($int32)	Number of records per page.
Sample Request	`N/A`
Sample Success Response	{ "content": [ { "firstName": "John", "fullName": "John Doe", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastName": "Doe", "username": "john.doe@test.com" } ], "numberOfElements": "10", "totalElements": "99", "number": "0", "size": "10", } Where: `content` – list of user objects `numberOfElements` – number of elements in content `number` – page number `size` –size from url parameter
Success Response	`Code:` `200` `OK`
Error Response	`Code:` `401` `Unauthorized` `Code:` `403` `Forbidden` `Code:` `404` `Not Found`

Powered by Zendesk