{"info":{"_postman_id":"b1ff9fe9-7533-4c74-85a9-eba1ad8aa179","name":"ACE API","description":"

The ACE API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The ACE API differs for every instance as we release new versions and tailor functionality.

Authentication

The ACE API uses API keys to authenticate requests. You can view and manage your API keys in your ACE user profile.

Your API keys can have many user privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authentication to the API can be performed is multiple ways. Authenticate to the API using one of the methods detailed below.

Basic Authentication

Authenticate your account using HTTP Basic Auth with your ACE username and password. The user must have access to the ACE API application.

Access Key Authentication

Authenticate your account using an ACE issued access key and secret access key. This authentication method is typically quicker than using username and password. The Access Key and Secret Access Key are generated within the ACE User Profile section.

The Access Key Authentication Token is comprised of The Access Key ID and Secret Access Key separated by two pipe characters.

Access Key Token Format ({{access_token}})

ACCESS_KEY_ID||SECRET_ACCESS_KEY\n\n

Example:

curl -H \"Authorization: Bearer {{access_token}}\" \n{{endpoint}}/service\n\n

OAuth Token Authentication

Authenticate your account using the OAuth authentication method. OAuth authentication access is configured within your ACE User Profile section.

Example:

curl -H \"Authorization: Bearer {{access_token}}\" \n{{endpoint}}/service\n\n

Generating a new Access Token

Go to the user profile in ACE and generate the Refresh Token if not generated. If the Refresh Token is already generated, copy the access code.
\n
Go to your API application. Create a new POST request. ({{endpoint}}/service/access-token)
\n

Note: Using the refresh token will invalidate all previous access tokens.

Refreshing Authentication Token

Go to your API application. Create a new POST request. ({{endpoint}}/authentication/refresh-token)

Note: Using the refresh token will invalidate all previous access tokens.

Responses

The structure of ACE API responses is as follows:

{\n    \"type\": String,\n    \"id\": String, // Optional\n    \"attributes\": {\n        \"attribute\": String || Array || Number,\n        ...\n    }\n}\n\n

Request (POST/PATCH/DELETE)

{\n    \"data\": {entity}\n}\n\n

Request with Multiple Entities (POST/PATCH/DELETE)

{\n    \"data\": [\n        {entity},\n        ...\n    ]\n}\n\n

Errors

ACE uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

Codes in the 2xx range indicate success.
\n
Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
\n
Codes in the 5xx range indicate an error with ACE's request or servers.
\n

Some 4xx errors that could be handled programmatically (e.g., Forbidden access) include an error code that briefly explains the error reported.

Error response

{\n    \"errors\": {\n        \"status\": Number,\n        \"detail\": String\n    }\n}\n\n

Example:

{\n    \"errors\": {\n        \"status\": 403,\n        \"detail\": \"Forbidden access\"\n    }\n}\n\n

Multiple errors response

{\n    \"errors\": [\n        {error},\n        ...\n    ]\n}\n\n

Error Handling

Our API calls raise exceptions for many reasons, such as a failed change, invalid parameters, authentication errors, and network unavailability. We recommend writing code that gracefully handles all possible API exceptions.

Pagination

All top-level API resources have support for bulk fetches via \"search\" API methods. For instance, you can search records, search projects, and search users. These search API methods share a common structure, taking at least these 2 parameters: limit & page

\n\n\n\n\n\n\n\n\n\n\n

Parameters
limit optional, default is 10 A limit on the number of objects to be returned between 1 and 100

Filtering

Filters can be used in your search requests to narrow down your results to find what you want. Filters should be sent as raw JSON and will use syntax similar to SQL.

Filter Query

Template

{\n   \"aql\": SELECT [COLUMNS] FROM [FROM] [WHERE]\n}\n\n

Example

{\n   \"aql\": \"SELECT username from __main__ WHERE username co \\\"User\\\"\"\n}\n\n

[COLUMN]

*REQUIRED
Data that will be displayed after the search request is processed. The data will be based off of the column names for entity's table as well as joined tables. You can add multiple columns by separating each column by a comma.

Example

{\n   \"aql\": \"SELECT id, username, status...\"\n}\n\n

NOTE: Extra expressions include the following: [COUNT], [SUM], and [CONCAT]

[COUNT]

*OPTIONAL
Returns the total number of items in the column based on the given conditions

Example

{\n   \"aql\": \"SELECT COUNT(id) FROM __main__ WHERE status eq 1\"\n}\n\n

[SUM]

*OPTIONAL
Returns the total sum of the values in a column based on the given conditions

[CONCAT]

*OPTIONAL
Returns the concatenated result of two or more values in a column based on the given conditions

Example

{\n   \"aql\": \"SELECT CONCAT(first_name, last_name) FROM __main__ WHERE id eq 1\"\n}\n\n

[FROM]

*REQUIRED
The table where you are querying data from. If you wish query from the current entity's table, use __main__. If you wish to join multiple tables, you can add them in the [JOIN] section as seen in the example below.

Example

{\n   \"aql\": \"SELECT id, username, status FROM __main__ [JOIN]...\"\n}\n\n

[JOIN]

*OPTIONAL
Used to join tables that have a relationship with each other. You may find which tables your entity has a relationship with from the GET request.

NOTE: When joining tables, be sure to add an alias to distinctly identify similar column names.

Example

{\n   \"aql\": \"SELECT id, p.first_name, p.last_name FROM __main__ JOIN person as p...\"\"\n}\n\n

[WHERE]

*OPTIONAL
The defined attributes that filters your results. There are four kinds of attributes: [CONDITION], [META], [GROUP], and [ORDER]

Template

{\n   \"... from __main__ [CONDITION]|[META] [GROUP] [ORDER]\"\n}\n\n

[CONDITION]

*OPTIONAL
This is where you compare column attributes for your entity to filter out your results. If you like to add multiple conditions, you may append additional conditions using AND or OR, as seen in the template below. There are 4 main types of conditions: [COMPARE], [IS], [IN], and [STRING].

NOTE: When comparing dates, keep in mind that Date/Datetime must follow ISO_8601 format for combined date and time: YYYY-MM-DDTHH:mm:ssZ

Example:

UTC timezone: 1970-01-01T00:00:00Z.

PST timezone: 1970-01-01T00:00:00-07:00

Template

{\n   \"... from __main__ WHERE [CONDITION] AND|OR [CONDITION]...\"\n}\n\n

[COMPARE]

*OPTIONAL
Conditions that compare numerical values and dates to a given column. With this condition, you can only use the following operators in your comparison:

{\n    \"gte\": Greater than or equal to (>=),    // Finds all results that are greater than or equal to the given value\n    \"gt\": Greater than (>),                 // Finds all results that are greater than to the given value\n    \"lte\": Less than or equal to (<=),        // Finds all results that are less than or equal to the given value\n    \"lt\": Less than (<),                    // Finds all results that are less than the given value\n    \"eq\": Equals (=),                        // Finds all results that are equal to the given value\n    \"neq\": Not equals (<>),                 // Finds all results that are not equal to the given value\n    \"like\": Like (~),                        // Finds all results that are similar to the given value\n    \"not like\": Not like (!~),                // Finds all results that are not similar to the given value\n}\n\n

Example

{\n   \"... WHERE status gte 1\"\n}\n\n

[IS]

*OPTIONAL
Conditions that check to see if there are any values set or not set for a given column. With this condition, you can only use the following operators:

{\n    \"is set\": Is set,            // Returns whether there are values set for the given column\n    \"is not set\": Is not set,     // Returns whether there are no values set for a given column\n    \"pr\": Is set                // This is the same as \"is set\"\n}\n\n

[IN]

*OPTIONAL
Conditions that check to see if any of the given set of values was set or not set for the given column. With this condition, you can only use the following operators:

{\n    \"in\": In,            // Returns whether one of the values in a given set was set for a given column\n    \"not in\": Not in,     // Returns whether one of the values in a given set was not set for a given column\n}\n\n

[STRING]

*OPTIONAL
Conditions that compare string values to a given column. With this condition, you can only use the following operators in your comparison:

{\n    \"sw\": Starts with, // Finds all results that starts with the given string\n    \"ew\": Ends with, // Finds all results that ends with the given string\n    \"co\": Contains, // Finds all results that contains the given string\n}\n\n

Example

{\n   \"... WHERE name sw|ew|co \\\"test\\\"\"\n}\n\n

NOTE: When dealing with strings, make sure to escape the quotations

[META]

*OPTIONAL
This is where you compare custom field attributes for your entity to filter out your results. If you like to add multiple conditions, you may append additional conditions using AND or OR, as seen in the template below. There are 3 main types of conditions: [COMPARE], [IS], and [IN].

Template

{\n   \"... from __main__ WHERE [META] AND|OR [META]...\"\n}\n\n

NOTE: When comparing dates, keep in mind that Date/Datetime must follow ISO_8601 format for combined date and time: YYYY-MM-DDTHH:mm:ssZ

Example:

UTC timezone: 1970-01-01T00:00:00Z.

PST timezone: 1970-01-01T00:00:00-07:00

[COMPARE]

*OPTIONAL
Conditions that compare numerical values and dates to a custom field (meta). With this condition, the operators you can use are the same as the [COMPARE] condition for [CONDITION]

[IS]

*OPTIONAL
Conditions that check to see if there are any values to a custom field (meta). With this condition, the operators you can use are the same as the [COMPARE] condition for [CONDITION]

[IN]

*OPTIONAL
Conditions that check to see if any of the given set of values was set for a custom field (meta). With this condition, the operators you can use are the same as the [COMPARE] condition for [CONDITION]

[GROUP]

*OPTIONAL
Used to group the results by one or more columns. Usually used in conjunction with aggregate functions such as [COUNT] and [SUM].

NOTE: This cannot be used with [META] conditions.

Template

{\n   \"aql\": \"... [WHERE] GROUP BY [COLUMN]\"\n}\n\n

Example

{\n   \"aql\": \"SELECT COUNT(id) FROM __main__ WHERE \\\"status\\\" eq 1 GROUP BY username\"\n}\n\n

[ORDER]

*OPTIONAL
Used to sort the results in ascending or descending order for one or more columns.

NOTE: This cannot be used with [META] conditions.

Example

{\n   \"aql\": \"SELECT id, username, status FROM __main__ WHERE \\\"status\\\" eq 1 ORDER BY id, username\"\n}\n\n

Rate Limits

API access rate limits are applied at a per-key basis in unit time. Every API response is accompanied by the following set of headers to identify the status of your consumption.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
X-Rate-Limit-Limit	The maximum number of requests allowed with in a 24 hr period.
X-Rate-Limit-Remaining	The number of requests remaining in the current time period.
X-Rate-Limit-Reset	The number of seconds to wait in order to get the maximum number of allowed requests. Once you hit the rate limit, you will receive a response similar to the following JSON, with a status code of 429 Too Many Requests.

{\n  \"error\": {\n    \"name\": \"rateLimitError\",\n    \"message\": \"Rate Limit exceeded. Please retry at 1465452702843\"\n  }\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Responses","slug":"responses"},{"content":"Errors","slug":"errors"},{"content":"Pagination","slug":"pagination"},{"content":"Filtering","slug":"filtering"},{"content":"Rate Limits","slug":"rate-limits"}],"owner":"4083921","collectionId":"b1ff9fe9-7533-4c74-85a9-eba1ad8aa179","publishedId":"TVRj6UP2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1970B9"},"publishDate":"2020-10-09T18:06:04.000Z"},"item":[{"name":"Applications","item":[{"name":"Retrieve All Applications","id":"b9605318-ccf1-495f-8d56-3ded32149a81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/modules","description":"

Returns a list of all applications that are available within ACE.

\n","urlObject":{"path":["modules"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"fd767161-4630-484d-bbb4-801a920de8f2","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/modules","description":"Search for modules"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"modules\",\"id\":\"audit\",\"attributes\":{\"product_name\":\"ACE Auditor™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":380}},{\"type\":\"modules\",\"id\":\"core\",\"attributes\":{\"product_name\":\"ACE™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":508}},{\"type\":\"modules\",\"id\":\"docs\",\"attributes\":{\"product_name\":\"ACE Docs™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":380}},{\"type\":\"modules\",\"id\":\"inspect\",\"attributes\":{\"product_name\":\"ACE Inspection™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":380}},{\"type\":\"modules\",\"id\":\"learning\",\"attributes\":{\"product_name\":\"ACE LMS™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":380}},{\"type\":\"modules\",\"id\":\"metrics\",\"attributes\":{\"product_name\":\"ACE Analytics™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":505}},{\"type\":\"modules\",\"id\":\"plm\",\"attributes\":{\"product_name\":\"ACE PLM™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":380}},{\"type\":\"modules\",\"id\":\"reglib\",\"attributes\":{\"product_name\":\"ACE RegLib™\",\"user_limit\":800,\"expire\":null},\"meta\":{\"total\":380}}],\"links\":{\"self\":{\"href\":\"/backend/v1/modules?page=1\"}},\"meta\":{\"totalCount\":8,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"b9605318-ccf1-495f-8d56-3ded32149a81"},{"name":"Retrieve Users in Applications","id":"2043cdc6-83d1-4d39-bf23-7b45ebab61ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/modules/{{module_id}}/users","description":"

Returns a list of users assigned to the given application.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

","urlObject":{"path":["modules","{{module_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b392d45e-9552-4512-bfac-c8114b8ca8d6","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/modules/{{module_id}}/users","description":"Gets a list of users assigned to the Module"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"users\",\n \"id\": \"1\",\n \"attributes\": {\n \"username\": \"tester\",\n \"failed_attempts\": 0,\n \"last_failed_date\": null,\n \"latest_activity_date\": null,\n \"status\": 1,\n \"latest_login_date\": \"2018-01-26T23:17:19+0000\"\n },\n \"links\": {\n \"self\": \"/backend/v1/users/1\"\n },\n \"relationships\": {\n \"person\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"people\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/modules/audit/users?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/modules/audit/users?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/modules/audit/users?page=19\"\n }\n },\n \"meta\": {\n \"totalCount\": 380,\n \"pageCount\": 19,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"2043cdc6-83d1-4d39-bf23-7b45ebab61ce"},{"name":"Retrieve Groups In Applications","id":"b8462430-d035-42e7-a76b-1104fcda469c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/modules/{{module_id}}/groups","description":"

Returns a list of groups assigned to the given application.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

","urlObject":{"path":["modules","{{module_id}}","groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"cab0ef81-7014-4f89-a391-8de563992bca","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/modules/{{module_id}}/groups","description":"Gets the list of groups assigned to a module"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"groups\",\"id\":\"7\",\"attributes\":{\"name\":\"ACE_System_Administrator\",\"description\":\"\",\"text\":\"ACE System Administrator\"},\"links\":{\"self\":\"/backend/v1/groups/7\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}},{\"type\":\"groups\",\"id\":\"8\",\"attributes\":{\"name\":\"ACE_Users\",\"description\":\"\",\"text\":\"ACE Users\"},\"links\":{\"self\":\"/backend/v1/groups/8\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/modules/audit/groups?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"b8462430-d035-42e7-a76b-1104fcda469c"},{"name":"Add Users to Applications","id":"64adbff2-4e8f-4fbb-9676-061badaceafa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n },\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/modules/{{module_id}}/users","description":"

Add user(s) to an ACE application if none of the user(s) were already assigned to the application. Replaces existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the user, this can be found by performing a GET {{endpoint}}/users request.

","urlObject":{"path":["modules","{{module_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"f68301e3-946d-4062-82a2-05a248e01eb1","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n },\n {\n \"id\": {{user_id4}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/modules/{{module_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"users\",\"id\":\"1\",\"attributes\":{\"username\":\"yhuang\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":\"2018-03-28T14:06:56+0000\",\"password_change_date\":\"2018-03-20T22:33:32+0000\",\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/1\"},\"relationships\":{\"person\":{\"data\":{\"id\":1,\"type\":\"people\"}}}},{\"type\":\"users\",\"id\":\"4\",\"attributes\":{\"username\":\"ptester\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":null,\"password_change_date\":null,\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/4\"},\"relationships\":{\"person\":{\"data\":{\"id\":4,\"type\":\"people\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/modules/audit/users?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"64adbff2-4e8f-4fbb-9676-061badaceafa"},{"name":"Add Groups to Applications","id":"cc48c1f7-9cf5-441c-8172-b41098870e98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{group_id}},\n \"type\": \"groups\"\n },\n {\n \"id\": {{group_id2}},\n \"type\": \"groups\"\n }\n ]\n}"},"url":"{{endpoint}}/modules/{{module_id}}/groups","description":"

Adds group(s) to the ACE application if none of the selected group(s) are already assigned to the application. Replace(s) any existing group if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `group_id` The assigned ID for the group, this can be found by performing a GET {{endpoint}}/group request.

","urlObject":{"path":["modules","{{module_id}}","groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"61b4c5ac-da10-4082-aebb-e4898103b6b3","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{group_id}},\n \"type\": \"groups\"\n },\n {\n \"id\": {{group_id2}},\n \"type\": \"groups\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/modules/{{module_id}}/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"groups\",\"id\":\"56\",\"attributes\":{\"name\":\"7c084e7c-5a8e-3169-b2ac-14b2daeb29a3\",\"description\":\"\",\"text\":\"Test Group Update (ID:56)\"},\"links\":{\"self\":\"/backend/v1/groups/56\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}},{\"type\":\"groups\",\"id\":\"55\",\"attributes\":{\"name\":\"e465bf69-20b8-37a2-991b-4afb0a00b6f1\",\"description\":\"\",\"text\":\"Test Group (ID:55)\"},\"links\":{\"self\":\"/backend/v1/groups/55\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/modules/audit/groups?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"cc48c1f7-9cf5-441c-8172-b41098870e98"},{"name":"Update Users in Applications","id":"ef1cd325-ce8a-423f-a8d8-bfad14883c2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/modules/{{module_id}}/users","description":"

Add user(s) to an ACE application if none of the user(s) were already assigned to the application. Appends to existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` ID of the users being added, this can be found be perfoming a GET{{endpoint}}/users request.

","urlObject":{"path":["modules","{{module_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"57bf7e6c-0de4-48d7-ba15-d26e38756de7","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id3}},\n \"type\": \"users\"\n },\n {\n \"id\": {{user_id2}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/modules/{{module_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"users\",\"id\":\"1\",\"attributes\":{\"username\":\"yhuang\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":\"2018-03-28T14:06:56+0000\",\"password_change_date\":\"2018-03-20T22:33:32+0000\",\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/1\"},\"relationships\":{\"person\":{\"data\":{\"id\":1,\"type\":\"people\"}}}},{\"type\":\"users\",\"id\":\"2\",\"attributes\":{\"username\":\"htester\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":null,\"password_change_date\":null,\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/2\"},\"relationships\":{\"person\":{\"data\":{\"id\":2,\"type\":\"people\"}}}},{\"type\":\"users\",\"id\":\"3\",\"attributes\":{\"username\":\"ftester\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":null,\"password_change_date\":null,\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/3\"},\"relationships\":{\"person\":{\"data\":{\"id\":3,\"type\":\"people\"}}}},{\"type\":\"users\",\"id\":\"4\",\"attributes\":{\"username\":\"ptester\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":null,\"password_change_date\":null,\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/4\"},\"relationships\":{\"person\":{\"data\":{\"id\":4,\"type\":\"people\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/modules/audit/users?page=1\"}},\"meta\":{\"totalCount\":4,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"ef1cd325-ce8a-423f-a8d8-bfad14883c2f"},{"name":"Update Groups in Applications","id":"79c9fb64-7d53-4581-bb69-d2c53b1130db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{group_id}},\n \"type\": \"groups\"\n },\n {\n \"id\": {{group_id2}},\n \"type\": \"groups\"\n }\n ]\n}"},"url":"{{endpoint}}/modules/{{module_id}}/groups","description":"

Adds group(s) to the ACE application if none of the selected group(s) are already assigned to the application. Appends to existing groups if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `group_id` The assigned ID for the group, this can be found by performing a GET {{endpoint}}/group request.

","urlObject":{"path":["modules","{{module_id}}","groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"6b3c44c0-af81-4cbe-9428-f5b8befd2137","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{group_id}},\n \"type\": \"groups\"\n },\n {\n \"id\": {{group_id2}},\n \"type\": \"groups\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/modules/{{module_id}}/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"groups\",\"id\":\"56\",\"attributes\":{\"name\":\"7c084e7c-5a8e-3169-b2ac-14b2daeb29a3\",\"description\":\"\",\"text\":\"Test Group Update (ID:56)\"},\"links\":{\"self\":\"/backend/v1/groups/56\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}},{\"type\":\"groups\",\"id\":\"55\",\"attributes\":{\"name\":\"e465bf69-20b8-37a2-991b-4afb0a00b6f1\",\"description\":\"\",\"text\":\"Test Group (ID:55)\"},\"links\":{\"self\":\"/backend/v1/groups/55\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/modules/audit/groups?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"79c9fb64-7d53-4581-bb69-d2c53b1130db"},{"name":"Remove Users from Applications","id":"f0c93f67-b2ba-4276-b81b-c9c43aaa25d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/modules/{{module_id}}/users","description":"

Remove users from a given ACE application.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the group, this can be found by performing a GET {{endpoint}}/users request.

","urlObject":{"path":["modules","{{module_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"62c80f6f-ef4c-4b92-aba9-c9b4c0609004","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"data\":[{\"id\":{{user_id}},\"type\":\"users\"}]}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/modules/{{module_id}}/users"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f0c93f67-b2ba-4276-b81b-c9c43aaa25d2"},{"name":"Remove Groups from Applications","id":"52da5191-5b69-48d7-a620-66823a0b19a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{group_id}},\n \"type\": \"groups\"\n },\n {\n \"id\": {{group_id2}},\n \"type\": \"groups\"\n }\n ]\n}"},"url":"{{endpoint}}/modules/{{module_id}}/groups","description":"

Remove groups from a given application.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`module_id`	Required The assigned ID for the module, this can be found by performing a GET {{endpoint}}/modules request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `group_id` The assigned ID for the group, this can be found by performing a GET {{endpoint}}/group request.

","urlObject":{"path":["modules","{{module_id}}","groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"465b510d-ab4a-48d2-bce0-dbf4121dadca","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{group_id}},\n \"type\": \"groups\"\n },\n {\n \"id\": {{group_id2}},\n \"type\": \"groups\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/modules/{{module_id}}/groups"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"52da5191-5b69-48d7-a620-66823a0b19a3"}],"id":"c1f52d7a-4895-41e1-89bc-d6a37c72766c","description":"

ACE Applications (also known as 'modules') are additional features within ACE that are only available to a client after they have purchased licenses for that application.

\n","event":[{"listen":"prerequest","script":{"id":"9e8252cb-5fa7-4984-a4a6-8779f0b01b58","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cd7f9939-10f5-4285-9147-b23c19ec04ef","type":"text/javascript","exec":[""]}}],"_postman_id":"c1f52d7a-4895-41e1-89bc-d6a37c72766c"},{"name":"Custom Fields","item":[{"name":"Retrieve All Custom Fields","id":"9dc8f584-5f25-4785-8b20-b6a968a0453e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-fields","description":"

Returns a list of all custom fields.

\n","urlObject":{"path":["custom-fields"],"host":["{{endpoint}}"],"query":[{"disabled":true,"key":"nocache","value":"1"}],"variable":[]}},"response":[{"id":"6036f64c-fbc4-412d-b38a-14ccb7e25dbe","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"custom-fields\",\"id\":\"-43\",\"attributes\":{\"fieldType\":\"radioButtonList\",\"label\":\"Require Retraining?\",\"description\":\"Determines whether the users would require to retrain when version is promoted. Participants who do not have a \\\"Passed\\\" status for the previous version will be retrained regardless.\",\"name\":\"require_retrain\",\"tooltip\":null,\"data\":{\"values\":[\"Yes\",\"No\"],\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null},\"datatype\":null,\"objectUrl\":null,\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-43\"}},{\"type\":\"custom-fields\",\"id\":\"-42\",\"attributes\":{\"fieldType\":\"picker\",\"label\":\"Unit of Measure\",\"description\":null,\"name\":\"unit_of_measure\",\"tooltip\":null,\"data\":{\"modelClass\":\"object\",\"insert\":\"0\",\"object_id\":\"-6\",\"parent_object_id\":\"\",\"filter\":false,\"filter_value\":false,\"data_filter_type\":\"none\",\"model_type\":false,\"record_lock\":null,\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null},\"datatype\":\"object\",\"objectUrl\":\"objects/search/-6\",\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-42\"}},{\"type\":\"custom-fields\",\"id\":\"-41\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Unit Name\",\"description\":null,\"name\":\"cf_uom_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-41\"}},{\"type\":\"custom-fields\",\"id\":\"-40\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Unit Abbreviation\",\"description\":null,\"name\":\"cf_uom_abbreviation\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-40\"}},{\"type\":\"custom-fields\",\"id\":\"-39\",\"attributes\":{\"fieldType\":\"radioButtonList\",\"label\":\"Rendition Type\",\"description\":\"Determines whether the document should be viewable by ACE Docs users as a PDF rendition or using the Source file\",\"name\":\"rendition_type\",\"tooltip\":null,\"data\":{\"values\":[\"Source\",\"PDF\"],\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null},\"datatype\":null,\"objectUrl\":null,\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-39\"}},{\"type\":\"custom-fields\",\"id\":\"-38\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Name\",\"description\":null,\"name\":\"cf_resource_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-38\"}},{\"type\":\"custom-fields\",\"id\":\"-37\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Country\",\"description\":null,\"name\":\"cf_address_country\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-37\"}},{\"type\":\"custom-fields\",\"id\":\"-36\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ZIP\",\"description\":null,\"name\":\"cf_address_zip\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-36\"}},{\"type\":\"custom-fields\",\"id\":\"-35\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"State/Province/Region\",\"description\":null,\"name\":\"cf_address_state\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-35\"}},{\"type\":\"custom-fields\",\"id\":\"-34\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"City\",\"description\":null,\"name\":\"cf_address_city\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-34\"}},{\"type\":\"custom-fields\",\"id\":\"-33\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Address Line 2\",\"description\":\"Apartment, suite, unit, building, floor, etc.\",\"name\":\"cf_address_line2\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-33\"}},{\"type\":\"custom-fields\",\"id\":\"-32\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Address Line 1\",\"description\":\"Street address, P.O. box, company name, c/o\",\"name\":\"cf_address_line1\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-32\"}},{\"type\":\"custom-fields\",\"id\":\"-31\",\"attributes\":{\"fieldType\":\"select\",\"label\":\"Type\",\"description\":null,\"name\":\"cf_address_type\",\"tooltip\":null,\"data\":{\"values\":[\"Business\",\"Home \",\"Other\"],\"field_size\":\"input-medium\"},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-31\"}},{\"type\":\"custom-fields\",\"id\":\"-30\",\"attributes\":{\"fieldType\":\"checkboxList\",\"label\":\"Primary\",\"description\":null,\"name\":\"cf_phone_options\",\"tooltip\":null,\"data\":{\"values\":[\"Primary\"]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-30\"}},{\"type\":\"custom-fields\",\"id\":\"-29\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Ext\",\"description\":null,\"name\":\"cf_phone_ext\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-29\"}},{\"type\":\"custom-fields\",\"id\":\"-28\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Number\",\"description\":null,\"name\":\"cf_phone_number\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-28\"}},{\"type\":\"custom-fields\",\"id\":\"-27\",\"attributes\":{\"fieldType\":\"select\",\"label\":\"Type\",\"description\":null,\"name\":\"cf_phone_type\",\"tooltip\":null,\"data\":{\"values\":[\"Main\",\"Mobile\",\"Work\",\"Home\",\"Work Fax\",\"Home Fax\",\"Pager\",\"Other\"],\"field_size\":\"input-medium\"},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-27\"}},{\"type\":\"custom-fields\",\"id\":\"-26\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Name\",\"description\":null,\"name\":\"cf_department_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-26\"}},{\"type\":\"custom-fields\",\"id\":\"-25\",\"attributes\":{\"fieldType\":\"checkboxList\",\"label\":\"Primary\",\"description\":null,\"name\":\"cf_company_options\",\"tooltip\":null,\"data\":{\"values\":[\"Primary\"]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-25\"}},{\"type\":\"custom-fields\",\"id\":\"-24\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Name\",\"description\":null,\"name\":\"cf_company_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-24\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/custom-fields?nocache=1&page=1\"},\"next\":{\"href\":\"/backend/v1/custom-fields?nocache=1&page=2\"},\"last\":{\"href\":\"/backend/v1/custom-fields?nocache=1&page=3\"}},\"meta\":{\"totalCount\":60,\"pageCount\":3,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"9dc8f584-5f25-4785-8b20-b6a968a0453e"},{"name":"Search Custom Fields","id":"de1dcee8-dc83-45ae-9a38-71407ae2ed09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select name, data, datatype from __main__ where type in (\\\"grid\\\")\"\n}"},"url":"{{endpoint}}/custom-fields/search","description":"

Returns a list of custom fields based on a filter.

\n","urlObject":{"path":["custom-fields","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"be866a4f-e2be-48c4-b7ac-f9349060b97a","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"custom-fields\",\"id\":\"-43\",\"attributes\":{\"fieldType\":\"radioButtonList\",\"label\":\"Require Retraining?\",\"description\":\"Determines whether the users would require to retrain when version is promoted. Participants who do not have a \\\"Passed\\\" status for the previous version will be retrained regardless.\",\"name\":\"require_retrain\",\"tooltip\":null,\"data\":{\"values\":[\"Yes\",\"No\"],\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null},\"datatype\":null,\"objectUrl\":null,\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-43\"}},{\"type\":\"custom-fields\",\"id\":\"-42\",\"attributes\":{\"fieldType\":\"picker\",\"label\":\"Unit of Measure\",\"description\":null,\"name\":\"unit_of_measure\",\"tooltip\":null,\"data\":{\"modelClass\":\"object\",\"insert\":\"0\",\"object_id\":\"-6\",\"parent_object_id\":\"\",\"filter\":false,\"filter_value\":false,\"data_filter_type\":\"none\",\"model_type\":false,\"record_lock\":null,\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null},\"datatype\":\"object\",\"objectUrl\":\"objects/search/-6\",\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-42\"}},{\"type\":\"custom-fields\",\"id\":\"-41\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Unit Name\",\"description\":null,\"name\":\"cf_uom_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-41\"}},{\"type\":\"custom-fields\",\"id\":\"-40\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Unit Abbreviation\",\"description\":null,\"name\":\"cf_uom_abbreviation\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-40\"}},{\"type\":\"custom-fields\",\"id\":\"-39\",\"attributes\":{\"fieldType\":\"radioButtonList\",\"label\":\"Rendition Type\",\"description\":\"Determines whether the document should be viewable by ACE Docs users as a PDF rendition or using the Source file\",\"name\":\"rendition_type\",\"tooltip\":null,\"data\":{\"values\":[\"Source\",\"PDF\"],\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null},\"datatype\":null,\"objectUrl\":null,\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-39\"}},{\"type\":\"custom-fields\",\"id\":\"-38\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Name\",\"description\":null,\"name\":\"cf_resource_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-38\"}},{\"type\":\"custom-fields\",\"id\":\"-37\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Country\",\"description\":null,\"name\":\"cf_address_country\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-37\"}},{\"type\":\"custom-fields\",\"id\":\"-36\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ZIP\",\"description\":null,\"name\":\"cf_address_zip\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-36\"}},{\"type\":\"custom-fields\",\"id\":\"-35\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"State/Province/Region\",\"description\":null,\"name\":\"cf_address_state\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-35\"}},{\"type\":\"custom-fields\",\"id\":\"-34\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"City\",\"description\":null,\"name\":\"cf_address_city\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-34\"}},{\"type\":\"custom-fields\",\"id\":\"-33\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Address Line 2\",\"description\":\"Apartment, suite, unit, building, floor, etc.\",\"name\":\"cf_address_line2\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-33\"}},{\"type\":\"custom-fields\",\"id\":\"-32\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Address Line 1\",\"description\":\"Street address, P.O. box, company name, c/o\",\"name\":\"cf_address_line1\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-32\"}},{\"type\":\"custom-fields\",\"id\":\"-31\",\"attributes\":{\"fieldType\":\"select\",\"label\":\"Type\",\"description\":null,\"name\":\"cf_address_type\",\"tooltip\":null,\"data\":{\"values\":[\"Business\",\"Home \",\"Other\"],\"field_size\":\"input-medium\"},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-31\"}},{\"type\":\"custom-fields\",\"id\":\"-30\",\"attributes\":{\"fieldType\":\"checkboxList\",\"label\":\"Primary\",\"description\":null,\"name\":\"cf_phone_options\",\"tooltip\":null,\"data\":{\"values\":[\"Primary\"]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-30\"}},{\"type\":\"custom-fields\",\"id\":\"-29\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Ext\",\"description\":null,\"name\":\"cf_phone_ext\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-29\"}},{\"type\":\"custom-fields\",\"id\":\"-28\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Number\",\"description\":null,\"name\":\"cf_phone_number\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-28\"}},{\"type\":\"custom-fields\",\"id\":\"-27\",\"attributes\":{\"fieldType\":\"select\",\"label\":\"Type\",\"description\":null,\"name\":\"cf_phone_type\",\"tooltip\":null,\"data\":{\"values\":[\"Main\",\"Mobile\",\"Work\",\"Home\",\"Work Fax\",\"Home Fax\",\"Pager\",\"Other\"],\"field_size\":\"input-medium\"},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-27\"}},{\"type\":\"custom-fields\",\"id\":\"-26\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Name\",\"description\":null,\"name\":\"cf_department_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-26\"}},{\"type\":\"custom-fields\",\"id\":\"-25\",\"attributes\":{\"fieldType\":\"checkboxList\",\"label\":\"Primary\",\"description\":null,\"name\":\"cf_company_options\",\"tooltip\":null,\"data\":{\"values\":[\"Primary\"]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-25\"}},{\"type\":\"custom-fields\",\"id\":\"-24\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"Name\",\"description\":null,\"name\":\"cf_company_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":null,\"field_size\":\"input-medium\",\"field_id\":\"-36\",\"customAttributeLabels\":null,\"oldLoggingData\":[],\"newLoggingData\":[]},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/-24\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/custom-fields?nocache=1&page=1\"},\"next\":{\"href\":\"/backend/v1/custom-fields?nocache=1&page=2\"},\"last\":{\"href\":\"/backend/v1/custom-fields?nocache=1&page=3\"}},\"meta\":{\"totalCount\":60,\"pageCount\":3,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"de1dcee8-dc83-45ae-9a38-71407ae2ed09"},{"name":"Create Custom Fields","id":"0cea0bc7-5813-4631-96da-6f84ef4245e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"type\": \"textfield\",\n \"fieldType\": \"textfield\",\n \"label\": \"This is a test\",\n \"description\": \"Checking\",\n \"name\": \"testingcustomfield1\",\n \"tooltip\": \"Tooltip\",\n \"data\": {\n \"max\": 255,\n \"validation_type\": \"percentage\",\n \"regular_expression\": null,\n \"currency_symbol\": \"$\",\n \"number_of_decimals\": 2,\n \"field_size\": \"input-xlarge\"\n },\n \"module\": \"form\"\n }\n }\n}"},"url":"{{endpoint}}/custom-fields","description":"

Body Parameters

There are several different types of custom fields that can be created, the type of custom field being created will determine what needs to be in the body. There are different attributes listed that can be used in the body to create a custom field.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`fieldType`	Required Type of the new custom field. *Valid values are as follows: `attachment`, `datepicker`, `datetimepicker`, `grid`, `checkboxList`, `Linkedfield`, `multiSelect`, `multiPicker`, `picker`, `radioButtonList`, `richtext`, `select`, `textarea`, `textfield`, `timepicker`, `variable`
`label`	Required The display label of the custom field.
`description`	Optional Detail of description of the new custom field.
`name`	Required The unique identifier of the custom. field *`name` must be unique
`tooltip`	Optional Option to configure the appearance.
`data`	Required The configuration details of the new custom field.
`module`	Optional The module used for the new custom field. *`module` must be a `form` or `object`

Addtional attributes if textfield is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`max`	Required Maximum length of the text field. *The maximum length range is 0~255 characters
`Field_size`	Optional The size of the text box.
`email`	optionalThe text field is only used to enter email address.
`validation_type`	Optional Validation type of text field. *Valid values you can choose are as follows: `number_only`, `email`, `url`, `percentage`, `number_of_decimals`, `currency_symbol`, `regular_expression`
`number_only`	The text field is only for pure number.
`email`	The text field is only for email address.
`url`	The text field is only for url.
`percentage`	The text field is only for percentage format.
> `number_of_decimals` *Only avaliable if percentage is selected as validation type	How many decimals are required for percentage format *`number_of_decimals` must be in range 0~10.
`currency`	The text field is only for currency
> `currency_symbol` *Only avaliable if currency is selected as validation type	The currency symbol used *`currency_symbol` must be a string
`reg_exp`	The text field is only for regular expression
> `regular_expression` *only avaliable if regular expression is selected as validation type	Specification of the regular expression information

Additional attributes if textarea or richtext is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`max`	Required Maximum length of the text field *The maximum length range is 0~65535 characters
`Field_size`	Optional The size of the text box

Additional attributes if grid is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`values`	Required Data array that defines the grid. It must contain the following attributes: `type`, `name`, and `key`
> `type`	Required Column type, checkbox or textbox *`type` must be either `0` for Checkbox of `1` for Textbox
> `name`	Required Name of the option in the grid
> `key`	Required Key of the option in the grid *`key` must be unique and have correct format

Additional attributes if select, multiSelect, radioButtonList, or checkboxList is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`values`	Required Data array that defines the options of this custom field. It must contain the following attributes:`data` and `key`
> `data`	Required Specify what kind of data is selecting
> `key`	Required Key of the option in the custom field *`key` must be unique and have correct format

Addtional attributes if datetimepicker is selected as fieldType. For date formats, see https://secure.php.net/manual/en/function.date.php for valid syntax:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`dateFormat`	Required The format to be used when selecting the date from a picker
`dateDisplayFormat`	Optional The format to be used when displaying the date throughout the application
`weekStart`	Required The day a week starts. You must set an integer as a value between 0-6, where `0` is Sunday and `6` is Saturday
`startView`	Optional The starting view when selecting the date in the datepicker. You currently must select the following options: `month` and `year`. If `year` is selected, specific days cannot be selected.
`showMeridian`	Optional This is to display the time in 12 hour format or 24 hour format. Select `0` for 24 hour format or `1` for 12 hour format.
`timeDisplayFormat`	Optional The format to be used when displaying the time throughout the application

Additional attributes if date_picker is selected as fieldType. For date formats, see https://secure.php.net/manual/en/function.date.php for valid syntax:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`format`	Required The format to be used when selecting the date from a picker
`displayFormat`	Optional The format to be used when displaying the date throughout the application
`weekStart`	Required The day a week starts. You must set an integer as a value between 0-6, where `0` is Sunday and `6` is Saturday
`viewMode`	Optional The starting view when selecting the date in the datepicker. You currently must select the following options: `days` and `months`

Additional attributes if picker or multiPicker is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`modelClass`	Required Data type being used for the picker *Valid values are as follows: `user`, `group`, `person`, `record`, `object`, `role`, `site`
`insert`	Optional Used to enable or disable the insert option in a picker *`insert` must be a boolean value
`record_lock`	Option is available if `record` is selected for `modelClass` Used to lock record configuration*`record_lock` must be a boolean value
`record_columns`	Option is available if `record` is selected for `modelClass` Add or remove columns to display
`object_id`	Required if `object` is selected for `modelClass` ID of the object
`data_filter_type`	Required Used to specify if the picker is a parent custom picker or not *Valid values are as follows: `parent`, `none`
`parent_object_id`	Required if `data_Filter_Type` is selected as `parent` ID of the parent object
`filter_value`	Required if `data_Filter_Type` is not selected as `none` Used to filter objects by a specific value(s)
`fieldSize`	Optional The size of the field if `picker` or `multipicker` is selected in `modelClass`

","urlObject":{"path":["custom-fields"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1c5e1a84-f1c3-41a0-8294-b1d83b1c1d50","name":"User Group Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"User Group Api Picker\",\n \"label\": \"group_group_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"user\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"group\",\n \"filter_value\": \"94\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"592\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"group_group_api\",\"description\":\"api field\",\"name\":\"usergroupapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"94\",\"data_filter_type\":\"group\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"25c87745-6c4a-4d13-b2d6-6f90ba13cb21","name":"User Project Role Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"User Role Api Picker\",\n \"label\": \"user_Role_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"user\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"role\",\n \"filter_value\": \"41\",\n \"role_type\": \"1\"\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"594\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"user_Role_api\",\"description\":\"api field\",\"name\":\"userroleapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"41\",\"data_filter_type\":\"role\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"26b27f22-3fc1-4bab-8e7f-410a125ec191","name":"User training Role Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"User TRole Api Picker\",\n \"label\": \"user_TRole_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"user\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"role\",\n \"filter_value\": \"2\",\n \"role_type\": \"2\"\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"595\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"user_TRole_api\",\"description\":\"api field\",\"name\":\"usertroleapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"2\",\"data_filter_type\":\"role\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"6206efef-4f8b-4fce-8165-7cbaa7e8b27d","name":"Record Picker","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"Record_picker_self\",\n \"label\": \"Record Picker 8 (self)\",\n \"description\": \"ACE 1401 POST Test\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"record\",\n \"insert\": null,\n \"object_id\": \"\",\n \"parent_object_id\": \"\",\n \"filter\": false,\n \"filter_value\": \"604\",\n \"data_filter_type\": \"self\",\n \"role_type\": false,\n \"model_type\": false,\n \"record_lock\": \"1\",\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"column\": null,\n \"field_size\": \"input-xlarge\",\n \"field_id\": false,\n \"customAttributeLabels\": null,\n \"lockRecord\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"606\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"Record Picker 8 (self)\",\"description\":\"ACE 1401 POST Test\",\"name\":\"record_picker_self\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"record\",\"insert\":null,\"record_lock\":\"1\",\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":\"\",\"parent_object_id\":\"\",\"filter_value\":\"604\",\"data_filter_type\":\"self\",\"field_size\":\"input-xlarge\"},\"datatype\":\"record\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"6d869c18-b342-4ed8-901d-1835a3b763f3","name":"Group parent data filter ","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"Group parent Api Picker\",\n \"label\": \"group_parent_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"group\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"parent\",\n \"filter_value\": \"589\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"590\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"group_parent_api\",\"description\":\"api field\",\"name\":\"groupparentapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"group\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"589\",\"data_filter_type\":\"parent\",\"field_size\":\"input-xlarge\"},\"datatype\":\"group\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"78009461-c7be-4023-98b6-ca82ec6dba58","name":"checkbox","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"api_checkboxes\",\n \"label\": \"Api Checkboxes\",\n \"description\": \"Ace 1401 POST Test\",\n \"fieldType\": \"checkboxList\",\n \"data\": {\n \"values\": [\n {\n \"data\": \"A\",\n \"key\": \"A100\"\n },\n {\n \"data\": \"B\",\n \"key\": \"B100\"\n },\n {\n \"data\": \"C\",\n \"key\": \"C100\"\n }\n ],\n \"field_size\": \"input-xlarge\",\n \"field_id\": false,\n \"customAttributeLabels\": null\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"621\",\"attributes\":{\"fieldType\":\"checkboxList\",\"label\":\"Api Checkboxes\",\"description\":\"Ace 1401 POST Test\",\"name\":\"api_checkboxes\",\"tooltip\":\"Tooltip\",\"data\":{\"values\":[{\"data\":\"A\",\"key\":\"A100\"},{\"data\":\"B\",\"key\":\"B100\"},{\"data\":\"C\",\"key\":\"C100\"}],\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"804800a3-c0dc-4ddb-92f5-f5a7082bcad7","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"type\": \"textfield\",\n \"fieldType\": \"textfield\",\n \"label\": \"This is a test\",\n \"description\": \"Checking\",\n \"name\": \"testingcustomfield1\",\n \"tooltip\": \"Tooltip\",\n \"data\": {\n \"max\": 255,\n \"validation_type\": \"percentage\",\n \"regular_expression\": null,\n \"currency_symbol\": \"$\",\n \"number_of_decimals\": 2,\n \"field_size\": \"input-xlarge\"\n },\n \"module\": \"form\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"22\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"This is a test\",\"description\":\"Checking\",\"name\":\"testingcustomfield1\",\"tooltip\":\"Tooltip\",\"data\":{\"max\":255,\"validation_type\":\"percentage\",\"regular_expression\":null,\"currency_symbol\":\"$\",\"number_of_decimals\":2,\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/22\"}}}"},{"id":"83415c2a-9b52-42e2-8bc0-ff23cba03285","name":"User Self success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"User Self Api Picker\",\n \"label\": \"user_self_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"user\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"self\",\n \"filter_value\": \"590\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"596\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"user_self_api\",\"description\":\"api field\",\"name\":\"userselfapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"590\",\"data_filter_type\":\"self\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"95b0c5d9-b6e2-4d28-9d61-75494d5589f9","name":"group site picker ","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"Group Site Api Picker\",\n \"label\": \"group_site_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"group\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"site\",\n \"filter_value\": \"93\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"591\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"group_site_api\",\"description\":\"api field\",\"name\":\"groupsiteapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"group\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"93\",\"data_filter_type\":\"site\",\"field_size\":\"input-xlarge\"},\"datatype\":\"group\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"9ff6931e-d674-4ca3-8d57-bd1a7253a472","name":"User Parent success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"User Parent Api Picker\",\n \"label\": \"user_parent_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"user\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"parent\",\n \"filter_value\": \"590\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"597\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"user_parent_api\",\"description\":\"api field\",\"name\":\"userparentapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"590\",\"data_filter_type\":\"parent\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"bc0c4ebb-6a1f-4c90-91dc-9a8ee86725c2","name":"User Site success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"User Site Api Picker\",\n \"label\": \"user_site_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"user\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"site\",\n \"filter_value\": \"93\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"593\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"user_site_api\",\"description\":\"api field\",\"name\":\"usersiteapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"93\",\"data_filter_type\":\"site\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"caeda737-29b6-4e94-854b-94f372c9f796","name":"User MultiPicker (Project Role)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"multipicker_of_type_Role\",\n \"label\": \"User Multi Picker\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"data_filter_type\": \"role\",\n \"role_type\": \"1\",\n \"filter_value\": \"140\",\n \"modelClass\": \"user\"\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"583\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"User Multi Picker\",\"description\":\"api field\",\"name\":\"multipicker_of_type_role\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":null,\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"140\",\"data_filter_type\":\"role\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"f4f63532-d663-4206-afa2-563e61636a04","name":"custom grid","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"grid_none\",\n \"label\": \"Grid B\",\n \"description\": \"Ace 1401 POST Test\",\n \"fieldType\": \"grid\",\n \"data\": {\n \"values\": {\n \"name\": [\n \"Checkbox 1\",\n \"Text Box 1\",\n \"Checkbox 2\",\n \"Text Box 2\"\n ],\n \"type\": [\n \"0\",\n \"1\",\n \"0\",\n \"1\"\n ],\n \"key\": [\n \"Checkbox15acbab5f06a2q\",\n \"TextBox15acbab5f06a7q\",\n \"Checkbox25acbab5f06abq\",\n \"TextBox25acbab5f06afq\"\n ]\n },\n \"history\": {\n \"Checkbox15acbab5f06a2q\": {\n \"name\": \"Checkbox 1\",\n \"type\": \"0\"\n },\n \"TextBox15acbab5f06a7q\": {\n \"name\": \"Text Box 1\",\n \"type\": \"1\"\n },\n \"Checkbox25acbab5f06abq\": {\n \"name\": \"Checkbox 2\",\n \"type\": \"0\"\n },\n \"TextBox25acbab5f06afq\": {\n \"name\": \"Text Box 2\",\n \"type\": \"1\"\n }\n },\n \"field_size\": \"input-xlarge\",\n \"field_id\": false,\n \"customAttributeLabels\": null,\n \"lockRecord\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"615\",\"attributes\":{\"fieldType\":\"grid\",\"label\":\"Grid B\",\"description\":\"Ace 1401 POST Test\",\"name\":\"grid_none\",\"tooltip\":\"Tooltip\",\"data\":{\"values\":{\"name\":[\"Checkbox 1\",\"Text Box 1\",\"Checkbox 2\",\"Text Box 2\"],\"type\":[\"0\",\"1\",\"0\",\"1\"],\"key\":[\"Checkbox15acbab5f06a2q\",\"TextBox15acbab5f06a7q\",\"Checkbox25acbab5f06abq\",\"TextBox25acbab5f06afq\"]},\"history\":{\"Checkbox15acbab5f06a2q\":{\"name\":\"Checkbox 1\",\"type\":\"0\"},\"TextBox15acbab5f06a7q\":{\"name\":\"Text Box 1\",\"type\":\"1\"},\"Checkbox25acbab5f06abq\":{\"name\":\"Checkbox 2\",\"type\":\"0\"},\"TextBox25acbab5f06afq\":{\"name\":\"Text Box 2\",\"type\":\"1\"}},\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"}}}"},{"id":"fbd89e0a-8147-40d1-99c0-3a7bd19c5e24","name":"Group Self success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"name\": \"Group Self Api Picker\",\n \"label\": \"group_self_api\",\n \"description\": \"api field\",\n \"fieldType\": \"multiPicker\",\n \"data\": {\n \"modelClass\": \"group\",\n \"filter\": false,\n \"record_columns\": \"pkey|title|project_id|initiator_id|status_id\",\n \"data_filter_type\": \"self\",\n \"filter_value\": \"588\",\n \"role_type\": false\n },\n \"module\": \"form\",\n \"tooltip\": \"Tooltip\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"589\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"group_self_api\",\"description\":\"api field\",\"name\":\"groupselfapipicker\",\"tooltip\":\"Tooltip\",\"data\":{\"modelClass\":\"group\",\"insert\":null,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"object_id\":null,\"parent_object_id\":null,\"filter_value\":\"588\",\"data_filter_type\":\"self\",\"field_size\":\"input-xlarge\"},\"datatype\":\"group\",\"objectUrl\":null,\"module\":\"form\"}}}"}],"_postman_id":"0cea0bc7-5813-4631-96da-6f84ef4245e8"},{"name":"Update Custom Fields","id":"bf07c050-3789-4d21-a862-5788abc5a6f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"label\": \"ACE 1401 Textfield Edit\",\n \"description\": \"PATCH EDIT\",\n \"tooltip\": \"Tooltip\",\n \"data\": {\n \"max\": 255,\n \"validation_type\": \"\",\n \"field_size\": \"input-xlarge\"\n },\n \"module\": \"form\"\n }\n }\n}"},"url":"{{endpoint}}/custom-fields/{{field_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
field_id	The assigned ID for the custom field, this can be found by performing a GET {{endpoint}}/custom-fields request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`label`	Required The display label of the new custom field.
`description`	Optional Detail of description of the new custom field.
`tooltip`	Optional Option to configure the appearance
`data`	Optional The configuration details of the new custom field

Additional attributes if textfield is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`max`	Required Maximum length of the text field *The maximum length range is 0~255 characters
`Field_size`	Optional The size of the text box
`email`	The text field is only used to enter email address
`validation_type`	Optional Validation type of text field *Valid values you can choose are as follows: `number_only`, `email`, `url`, `percentage`, `number_of_decimals`, `currency_symbol`, `regular_expression`
`number_only`	The text field is only for pure number
`email`	The text field is only for email address
`url`	The text field is only for url
`percentage`	The text field is only for percentage format
> `number_of_decimals` *Only avaliable if percentage is selected as validation type	How many decimals are required for percentage format *`number_of_decimals` must be in range 0~10
`currency`	The text field is only for currency
> `currency_symbol` *Only avaliable if currency is selected as validation type	The currency symbol used *`currency_symbol` must be a string
`reg_exp`	The text field is only for regular expression
> `regular_expression` *only avaliable if regular expression is selected as validation type	Specification of the regular expression information

Additional attributes if textarea or richtext is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`max`	Required Maximum length of the text field *The maximum length range is 0~65535 characters
`Field_size`	Optional The size of the text box

Additional attributes if grid is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`values`	Required Data array that defines the grid. It must contain the following attributes: `type`, `name`, and `key`
> `type`	Required Column type, checkbox or textbox *`type` must be either `0` for Checkbox of `1` for Textbox
> `name`	Required Name of the option in the grid
> `key`	Required Key of the option in the grid *`key` must be unique and have correct format

Additional attributes if select, multiSelect, radioButtonList, or checkboxList is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`values`	Required Data array that defines the options of this custom field. It must contain the following attributes:`data` and `key`
> `data`	Required Specify what kind of data is selecting
> `key`	Required Key of the option in the custom field *`key` must be unique and have correct format

Additional attributes if datetimepicker is selected as fieldType. For date formats, see https://secure.php.net/manual/en/function.date.php for valid syntax:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`dateFormat`	Required The format to be used when selecting the date from a picker
`dateDisplayFormat`	Optional The format to be used when displaying the date throughout the application
`weekStart`	Required The day a week starts. You must set an integer as a value between 0-6, where `0` is Sunday and `6` is Saturday
`startView`	Optional The starting view when selecting the date in the datepicker. You currently must select the following options: `month` and `year`. If `year` is selected, specific days cannot be selected.
`showMeridian`	Optional This is to display the time in 12 hour format or 24 hour format. Select `0` for 24 hour format or `1` for 12 hour format.
`timeDisplayFormat`	Optional The format to be used when displaying the time throughout the application

Additional attributes if date_picker is selected as fieldType. For date formats, see https://secure.php.net/manual/en/function.date.php for valid syntax:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`format`	Required The format to be used when selecting the date from a picker
`displayFormat`	Optional The format to be used when displaying the date throughout the application
`weekStart`	Required The day a week starts. You must set an integer as a value between 0-6, where `0` is Sunday and `6` is Saturday
`viewMode`	Optional The starting view when selecting the date in the datepicker. You currently must select the following options: `days` and `months`

Additional attributes if picker or multiPicker is selected as fieldType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`modelClass`	Required Data type being used for the picker *Valid values are as follows: `user`, `group`, `person`, `record`, `object`, `role`, `site`
`insert`	Optional Used to enable or disable the insert option in a picker *`insert` must be a boolean value
`record_lock`	Option is available if `record` is selected for `modelClass` Used to lock record configuration*`record_lock` must be a boolean value
`record_columns`	Option is available if `record` is selected for `modelClass` Add or remove columns to display
`object_id`	Required if `object` is selected for `modelClass` ID of the object
`data_filter_type`	Required Used to specify if the picker is a parent custom picker or not *Valid values are as follows: `parent`, `none`
`parent_object_id`	Required if `data_Filter_Type` is selected as `parent` ID of the parent object
`filter_value`	Required if `data_Filter_Type` is not selected as `none` Used to filter objects by a specific value(s)
`fieldSize`	Optional The size of the field if `picker` or `multipicker` is selected in `modelClass`

","urlObject":{"path":["custom-fields","{{field_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"c276c09b-b298-4995-9b58-2df3d1aa6ffd","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-fields\",\n \"attributes\": {\n \"label\": \"ACE 1401 Textfield Edit\",\n \"description\": \"PATCH EDIT\",\n \"tooltip\": \"Tooltip\",\n \"data\": {\n \"max\": 255,\n \"validation_type\": \"\",\n \"field_size\": \"input-xlarge\"\n },\n \"module\": \"form\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-fields/{{field_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-fields\",\"id\":\"2\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 Textfield Edit\",\"description\":\"PATCH EDIT\",\"name\":\"ace1401textfield\",\"tooltip\":\"Tooltip\",\"data\":{\"max\":255,\"validation_type\":\"\",\"regular_expression\":null,\"currency_symbol\":\"$\",\"number_of_decimals\":2,\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"}}}"}],"_postman_id":"bf07c050-3789-4d21-a862-5788abc5a6f0"},{"name":"Delete Custom Fields","id":"c0ce15a7-747e-4b40-8a10-193fcbbc688e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/custom-fields/{{field_id}}","description":"

A custom field can only be deleted if it has not previously been used.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
field_id	The assigned ID for the custom field, this can be found by performing a GET {{endpoint}}/custom-fields request.

","urlObject":{"path":["custom-fields","{{field_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"7a9b9786-0e54-4383-b692-e85d0f6444b0","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/custom-fields/{{field_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c0ce15a7-747e-4b40-8a10-193fcbbc688e"}],"id":"1991e2c4-c7ca-4917-816e-a62b6068c9a1","description":"

Custom fields are different types of user interfaces that can be added to collect data during a workflow transition. There are several different types of custom fields. These custom fields can be used in forms, report templates, analytics, and the workspace to gather data. Please refer to the ACE Administration Guide for a full list of all available custom field types.

\n","event":[{"listen":"prerequest","script":{"id":"f1e5dc4c-c96e-412e-ac5b-bf529cdc982c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e006c13f-2720-4321-a4fa-2359cb16f1f4","type":"text/javascript","exec":[""]}}],"_postman_id":"1991e2c4-c7ca-4917-816e-a62b6068c9a1"},{"name":"Custom Forms","item":[{"name":"Retrieve All Custom Forms","id":"f59ebc8f-cfcf-4174-acd0-5254fb928dd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-forms","description":"

Returns a list of custom forms.

\n","urlObject":{"path":["custom-forms"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e5124d01-9c06-4cfb-9c98-03bc0fd9d29a","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-forms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"custom-forms\",\"id\":\"-1\",\"attributes\":{\"type\":\"vertical\",\"name\":\"Default Form\",\"description\":\"This is the default form.\"}},{\"type\":\"custom-forms\",\"id\":\"1\",\"attributes\":{\"type\":\"vertical\",\"name\":\"CD Form\",\"description\":\"\"}},{\"type\":\"custom-forms\",\"id\":\"3\",\"attributes\":{\"type\":\"vertical\",\"name\":\"ACE Form Test 1\",\"description\":\"Checking how a form is created manually in ACE\"}},{\"type\":\"custom-forms\",\"id\":\"5\",\"attributes\":{\"type\":\"vertical\",\"name\":\"Test Form\",\"description\":\"Test Form Description\"}},{\"type\":\"custom-forms\",\"id\":\"17\",\"attributes\":{\"type\":\"vertical\",\"name\":\"ACE 1401 Test Form Edit\",\"description\":\"Description EDIT\"}},{\"type\":\"custom-forms\",\"id\":\"18\",\"attributes\":{\"type\":\"vertical\",\"name\":\"ACE 1401 Test Form\",\"description\":\"Test Form Description\"}},{\"type\":\"custom-forms\",\"id\":\"19\",\"attributes\":{\"type\":\"vertical\",\"name\":\"ACE 1401 Test Form 2 Edit 2\",\"description\":\"Description 2 EDIT 2\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/custom-forms?page=1\"}},\"meta\":{\"totalCount\":7,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"f59ebc8f-cfcf-4174-acd0-5254fb928dd0"},{"name":"Retrieve Field Details In Forms","id":"25160d6c-ad51-46db-a481-5b5534cd0f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-forms/{{form_id}}/fields","description":"

Returns details on the fields configured to the form.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
form_id	The assigned ID for the custom form, this can be found by performing a GET {{endpoint}}/custom-forms request.

","urlObject":{"path":["custom-forms","{{form_id}}","fields"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"52fb514e-e3da-4ec3-9174-e6204c5066a9","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/forms/{{form_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"custom-fields\",\"id\":\"1\",\"attributes\":{\"fieldType\":\"picker\",\"label\":\"This is a test\",\"description\":\"Checking\",\"name\":\"testingcustomfield2\",\"tooltip\":null,\"data\":{\"modelClass\":\"user\",\"insert\":null,\"record_lock\":null,\"record_columns\":null,\"object_id\":null,\"parent_object_id\":null,\"filter_value\":null,\"data_filter_type\":\"none\",\"field_size\":\"input-xlarge\"},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"\"}},{\"type\":\"custom-fields\",\"id\":\"2\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 Textfield\",\"description\":\"ACE-1401 Testing POST\",\"name\":\"ace1401textfield\",\"tooltip\":\"Tooltip\",\"data\":{\"max\":255,\"validation_type\":\"\",\"regular_expression\":null,\"currency_symbol\":\"$\",\"number_of_decimals\":2,\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"}},{\"type\":\"custom-fields\",\"id\":\"3\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 Textfield2\",\"description\":\"ACE-1401 Testing POST2\",\"name\":\"ace1401textfield2\",\"tooltip\":\"Tooltip\",\"data\":{\"max\":255,\"validation_type\":\"\",\"regular_expression\":null,\"currency_symbol\":\"$\",\"number_of_decimals\":2,\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"}},{\"type\":\"custom-fields\",\"id\":\"4\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 TextField Manual\",\"description\":\"Manually Added the textfield for comparison\",\"name\":\"cf_ace_1401_textfield_manual\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":\"\",\"currency_symbol\":\"$\",\"number_of_decimals\":\"2\",\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null,\"lockRecord\":false},\"datatype\":null,\"objectUrl\":null,\"module\":\"form\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/forms/1/fields?page=1\"}},\"meta\":{\"totalCount\":4,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"25160d6c-ad51-46db-a481-5b5534cd0f14"},{"name":"Retrieve Custom Form History","id":"919ac6eb-0b5c-40b8-b690-07e3005e5f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/custom-forms/{{form_id}}/histories","description":"

Returns the versioning information for the custom form.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
form_id	The assigned ID for the custom from, this can be found by performing a GET {{endpoint}}/custom-forms request.

","urlObject":{"path":["custom-forms","{{form_id}}","histories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"a10400d6-9e0e-4833-ac62-1b13da55b3dd","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/forms/{{form_id}}/histories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"form-histories\",\"id\":\"1\",\"attributes\":{\"is_current\":1,\"is_draft\":0,\"version\":1,\"last_updated\":\"2018-03-20T20:23:35+0000\"},\"relationships\":{\"creator\":{\"data\":{\"id\":-1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":1,\"type\":\"forms\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/forms/1/histories?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"919ac6eb-0b5c-40b8-b690-07e3005e5f92"},{"name":"Create Custom Forms","id":"ab1cd46a-f249-4f7a-8f4b-a809480fbc34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-forms\",\n \"attributes\": {\n \"name\": \"ACE 1401 Test Form\",\n \"description\": \"Test Form Description\"\n }\n }\n}"},"url":"{{endpoint}}/custom-forms","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`name`	Required Name of the new form.
`description`	Optional Description of the new form.
`type`	Required The position a lable will be displayed relative to the fields contained in the form. Labels can be top aligned above or left aligned to the left of a field. *Must be 'vertical' or 'horizontal'

","urlObject":{"path":["custom-forms"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"ae563cf7-64db-4205-9504-f3a4ea917def","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-forms\",\n \"attributes\": {\n \"name\": \"ACE 1401 Test Form 3\",\n \"description\": \"Test Form Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/custom-forms"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"custom-forms\",\"id\":\"20\",\"attributes\":{\"type\":null,\"name\":\"ACE 1401 Test Form 3\",\"description\":\"Test Form Description\"}}}"}],"_postman_id":"ab1cd46a-f249-4f7a-8f4b-a809480fbc34"},{"name":"Update Custom Forms","id":"6ee3b63d-adde-4340-a3d8-046644aa4ff2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"custom-forms\",\n \"attributes\": {\n \"name\": \"ACE 1401 Test Form Edit\",\n \"description\": \"Description EDIT\",\n \"type\": \"vertical\"\n }\n }\n}"},"url":"{{endpoint}}/custom-forms/{{form_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
form_id	The assigned ID for the custom form, this can be found by performing a GET {{endpoint}}/custom-forms request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`name`	Required Name of the custom form.
`description`	Optional Description of the custom form.
`type`	Required The position a lable will be displayed relative to the fields contained in the form. Labels can be top aligned above a field or left aligned to the left of a field. *Must be 'vertical' or 'horizontal'

","urlObject":{"path":["custom-forms","{{form_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"8ba40bbd-85f2-42d0-bfe0-f93b30428fce","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"forms\",\n \"attributes\": {\n \"name\": \"ACE 1401 Test Form Edit\",\n \"description\": \"Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/forms/{{form_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"forms\",\"id\":\"17\",\"attributes\":{\"type\":\"vertical\",\"name\":\"ACE 1401 Test Form Edit\",\"description\":\"Description EDIT\"}}}"}],"_postman_id":"6ee3b63d-adde-4340-a3d8-046644aa4ff2"},{"name":"Delete Custom Forms","id":"e6d20537-8af1-4c27-a49a-37e8141dc645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/custom-forms/{{form_id}}","description":"

A custom form can only be deleted if it is inactive.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
form_id	The assigned ID for the custom form, this can be found by performing a GET {{endpoint}}/custom-forms request.

","urlObject":{"path":["custom-forms","{{form_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"112025c2-533b-4eee-8d6a-ebfa88aa5444","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/custom-forms/20"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e6d20537-8af1-4c27-a49a-37e8141dc645"}],"id":"0775c52b-b668-4dd6-9a66-2baea19a77e4","description":"

Forms are a combination of custom fields used to gather data from a user during a workflow transition. The form can be configured to different numbers of rows and columns as desired.

\n","event":[{"listen":"prerequest","script":{"id":"8ec7f66f-2519-4717-9361-49e6c0e59bb4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2e3195b-534f-4db1-9d93-f235bf94d0f4","type":"text/javascript","exec":[""]}}],"_postman_id":"0775c52b-b668-4dd6-9a66-2baea19a77e4"},{"name":"Form History","item":[{"name":"Retrieve All Form History","id":"c018c975-fe80-45e3-b7c6-87c9c332a041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/form-histories","description":"

Returns all custom form versioning details.

\n","urlObject":{"path":["form-histories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3c183c9a-27f5-4886-98bd-810fd9926a0d","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/form-histories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"form-histories\",\"id\":\"-1\",\"attributes\":{\"is_current\":1,\"is_draft\":0,\"version\":1,\"last_updated\":\"2018-03-20T19:02:47+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/-1\"},\"relationships\":{\"creator\":{\"data\":{\"id\":-1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":-1,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"1\",\"attributes\":{\"is_current\":0,\"is_draft\":0,\"version\":1,\"last_updated\":\"2018-03-20T20:23:35+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/1\"},\"relationships\":{\"creator\":{\"data\":{\"id\":-1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":1,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"2\",\"attributes\":{\"is_current\":1,\"is_draft\":0,\"version\":1,\"last_updated\":\"2018-04-06T18:29:05+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/2\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":3,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"3\",\"attributes\":{\"is_current\":1,\"is_draft\":0,\"version\":1,\"last_updated\":\"2018-04-10T21:46:19+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/3\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":5,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"12\",\"attributes\":{\"is_current\":0,\"is_draft\":0,\"version\":1,\"last_updated\":\"2018-04-09T17:27:10+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/12\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":23,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"13\",\"attributes\":{\"is_current\":0,\"is_draft\":0,\"version\":2,\"last_updated\":\"2018-04-09T18:57:08+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/13\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":1,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"14\",\"attributes\":{\"is_current\":1,\"is_draft\":0,\"version\":3,\"last_updated\":\"2018-04-10T22:23:16+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/14\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":1,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"15\",\"attributes\":{\"is_current\":0,\"is_draft\":1,\"version\":4,\"last_updated\":\"2018-04-10T22:27:51+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/15\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":1,\"type\":\"custom-forms\"}}}},{\"type\":\"form-histories\",\"id\":\"16\",\"attributes\":{\"is_current\":1,\"is_draft\":0,\"version\":2,\"last_updated\":\"2018-04-11T21:34:59+0000\"},\"links\":{\"self\":\"/backend/v1/form-histories/16\"},\"relationships\":{\"creator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"form\":{\"data\":{\"id\":23,\"type\":\"custom-forms\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/form-histories?page=1\"}},\"meta\":{\"totalCount\":9,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"c018c975-fe80-45e3-b7c6-87c9c332a041"},{"name":"Retrieve Field Details in Form History","id":"8a91a45a-88f0-493a-affc-a85abfeabe14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/form-histories/{{history_id}}/fields","description":"

Returns details about custom fields in a specific version of a custom form.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
historyID	The assigned ID for the history of the form, this can be found by performing a GET {{endpoint}}/form-histories request.

","urlObject":{"path":["form-histories","{{history_id}}","fields"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"837097e4-02c6-4107-9232-5b363e63d4d8","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/form-histories/{{history_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"custom-fields\",\"id\":\"2\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 Textfield Edit\",\"description\":\"PATCH EDIT\",\"name\":\"ace1401textfield\",\"tooltip\":\"Tooltip\",\"data\":{\"max\":255,\"validation_type\":\"\",\"regular_expression\":null,\"currency_symbol\":\"$\",\"number_of_decimals\":2,\"field_size\":\"input-xlarge\"},\"datatype\":\"\",\"objectUrl\":null,\"module\":\"form\"},\"links\":{\"self\":\"/backend/v1/custom-fields/2\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/form-histories/16/fields?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"8a91a45a-88f0-493a-affc-a85abfeabe14"}],"id":"86b8d2e3-cbeb-44b1-8ec3-ba4acf62df33","description":"

The form history is used to record the form version and indicate whether the form is in active state. Once a form is used in a workflow, it becomes active and a draft must be created in order to make changes. This allows a form to be used in records while it is also being edited. After the desired changes have been made, the draft must be published before the changes are effective.

\n","event":[{"listen":"prerequest","script":{"id":"2bec0fee-e2b5-47de-bace-b0ffb422a612","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"86f6500e-77f2-40f8-8cd8-c0070b3912a4","type":"text/javascript","exec":[""]}}],"_postman_id":"86b8d2e3-cbeb-44b1-8ec3-ba4acf62df33"},{"name":"Groups","item":[{"name":"Retrieve All Groups","id":"5d7e7ef3-1da6-4861-91c1-bc65a8b7c329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/groups","description":"

Returns a list of details for all user groups.

\n","urlObject":{"path":["groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"88e90334-c45d-417b-ae63-a85c9df5d3c1","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"groups\",\n \"id\": \"66\",\n \"attributes\": {\n \"name\": \"31cbf25d-68c8-3b41-9bf5-680706c54ef6\",\n \"description\": \"Group description\",\n \"text\": \"Group text\"\n },\n \"links\": {\n \"self\": \"/backend/v1/groups/66\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": 43,\n \"type\": \"sites\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/groups?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/groups?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v1/groups?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"5d7e7ef3-1da6-4861-91c1-bc65a8b7c329"},{"name":"Retrieve All Users in a Group","id":"3a7a94cc-06df-4d55-93a1-1d0f48f4320e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/groups/{{group_id}}/users","description":"

Returns a list of all users within a group.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

","urlObject":{"path":["groups","{{group_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"a884f330-0963-4798-b538-e4378c6b3564","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/groups/{{group_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"users\",\n \"id\": \"1\",\n \"attributes\": {\n \"username\": \"tester\",\n \"failed_attempts\": 0,\n \"last_failed_date\": null,\n \"latest_activity_date\": null,\n \"status\": 1,\n \"latest_login_date\": \"2018-01-19T22:24:45+0000\"\n },\n \"links\": {\n \"self\": \"/backend/v1/users/1\"\n },\n \"relationships\": {\n \"person\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"people\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/groups/7/users?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 5,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"3a7a94cc-06df-4d55-93a1-1d0f48f4320e"},{"name":"Retrieve All Permissions of a Group","id":"39d97849-3bd1-4f51-ba57-820d2bcde69c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/groups/{{group_id}}/permissions","description":"

Returns a list of configured permissions for a group.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

","urlObject":{"path":["groups","{{group_id}}","permissions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d04ebeb0-4598-47e0-b3fb-bcb49b0a6211","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/groups/{{group_id}}/permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"permissions\",\"id\":\"24\",\"attributes\":{\"name\":\"global_admin\",\"description\":\"Ability to perform most user & group administration functions.
Note: People with this permission can always log in.\",\"text\":\"Administrators\"}}]}"}],"_postman_id":"39d97849-3bd1-4f51-ba57-820d2bcde69c"},{"name":"Search Groups","id":"f25bcd5f-090c-4caf-bf35-435f4dc9ddda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select name, text, description from __main__ where id eq 2\"\n}"},"url":"{{endpoint}}/groups/search","description":"

Returns a list of groups.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["groups","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"05f05a55-7b9e-4d24-8c76-97682ffa84b1","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"groups\",\"id\":\"55\",\"attributes\":{\"name\":\"e465bf69-20b8-37a2-991b-4afb0a00b6f1\",\"description\":null,\"text\":\"Test Group\"},\"links\":{\"self\":\"/backend/v1/groups/55\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/groups/search?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"f25bcd5f-090c-4caf-bf35-435f4dc9ddda"},{"name":"Create Groups","id":"e60ebe10-610c-48e6-8201-bb01a07c0b99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"text\": \"hello world\",\n \"site\": {{site_id}}\n },\n \"type\": \"groups\"\n }\n}"},"url":"{{endpoint}}/groups","description":"

Create a new user group.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`text`	Required Description of the new group. *Must be unique
`site`	Required `site_id` This can be found by performing a GET {{edpoint}}/site request. Site which the new group belongs to. *Must be a existing site
`type`	Optional Type of the new group.
`description`	Optional Description of the group.

","urlObject":{"path":["groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e5977195-17b0-4834-a621-0ff380df44a3","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"text\": \"hello world\",\n \"site\": {{site_id}}\n },\n \"type\": \"groups\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"groups\",\"id\":\"\",\"attributes\":{\"name\":\"78f2afe4-84a7-3a35-bc7f-d17192e9732a\",\"description\":null,\"text\":\"hello world\"},\"links\":{\"self\":\"/backend/v1/group/view\"},\"relationships\":{\"site\":{\"data\":{\"id\":71,\"type\":\"sites\"}}}}}"}],"_postman_id":"e60ebe10-610c-48e6-8201-bb01a07c0b99"},{"name":"Add Users to Group","id":"eeb4a315-55ea-4377-a8d5-3aa613df6895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/groups/{{group_id}}/users","description":"

Add user(s) to a group if none of the user(s) were already assigned to the group. Replaces existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the user, this can be found by performing a GET {{endpoint}}/users request.

","urlObject":{"path":["groups","{{group_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5ef11d8b-e5fc-42bf-a26e-04fa8c37aa01","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"groups\",\"id\":\"6\",\"attributes\":{\"name\":\"ACE_Administrator\",\"description\":\"\",\"text\":\"updated text\"},\"links\":{\"self\":\"/backend/v1/groups/6\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}}"}],"_postman_id":"eeb4a315-55ea-4377-a8d5-3aa613df6895"},{"name":"Add Permissions to Groups","id":"ce59559b-5208-4dda-89b6-b8cfb134254a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{permission_id}},\n \"type\": \"permissions\"\n }\n ]\n}"},"url":"{{endpoint}}/groups/{{group_id}}/permissions","description":"

Add permission(s) to a group if none of the permission(s) were already assigned to the group. Replaces existing permissions if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `permissions_id` The assigned ID for a permission, this can be found by performing a GET {{endpoint}}/permissions request.
`type`	Required \"Permissions\"

","urlObject":{"path":["groups","{{group_id}}","permissions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"68d7d8d9-2983-41d0-89f3-a526b3dd7090","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"25, 90\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"90\",\n \"type\": \"permissions\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group__id}}/permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"permissions\",\"id\":\"90\",\"attributes\":{\"name\":\"global_api\",\"description\":\"ACE API\",\"text\":\"API\"}},{\"type\":\"permissions\",\"id\":\"25\",\"attributes\":{\"name\":\"global_browseUser\",\"description\":\"Ability to select a user or group from a popup window. Users with this permission will be able to see names of all users and groups in the system.\",\"text\":\"Browse Users\"}}]}"}],"_postman_id":"ce59559b-5208-4dda-89b6-b8cfb134254a"},{"name":"Update Groups","id":"5cfa932b-1d7b-4998-8d48-70f0669ca1ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"text\": \"updated text\"\n },\n \"type\": \"groups\",\n \"id\": {{group_id}}\n }\n}"},"url":"{{endpoint}}/groups/{{group_id}}","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`text`	Required Description of the group. *Must be unique
`type`	Required \"groups\"
`id`	Required `group_id` The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

","urlObject":{"path":["groups","{{group_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"aa39975a-9f94-4270-a4a3-4b2fbcaff422","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"text\": \"updated text\"\n },\n \"type\": \"groups\",\n \"id\": {{group_id}}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"groups\",\"id\":\"6\",\"attributes\":{\"name\":\"ACE_Administrator\",\"description\":\"\",\"text\":\"updated text\"},\"links\":{\"self\":\"/backend/v1/groups/6\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}}"}],"_postman_id":"5cfa932b-1d7b-4998-8d48-70f0669ca1ca"},{"name":"Update Users in Groups","id":"722a8d23-2cbf-4a65-a30d-c16ac74d2f12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/groups/{{group_id}}/users","description":"

Adds user(s) to the group if none of the selected user(s) are already assigned to the group. Appends to existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the user, this can be found by performing a GET {{endpoint}}/users request.
`type`	Required \"groups\"

","urlObject":{"path":["groups","{{group_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"91fe0a92-9f1e-442f-b333-c70f5b80deb6","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"groups\",\"id\":\"6\",\"attributes\":{\"name\":\"ACE_Administrator\",\"description\":\"\",\"text\":\"updated text\"},\"links\":{\"self\":\"/backend/v1/groups/6\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}}"}],"_postman_id":"722a8d23-2cbf-4a65-a30d-c16ac74d2f12"},{"name":"Update Permissions in Groups","id":"2e6db3eb-d9d4-40d4-8e22-74b028ed8dae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{permission_id}},\n \"type\": \"permissions\"\n }\n ]\n}"},"url":"{{endpoint}}/groups/{{group_id}}/permissions","description":"

Adds permission(s) to the group if none of the selected permission(s) are already assigned to the group. Appends to existing permissions if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `permissions_id` The assigned ID for a permission, this can be found by performing a GET {{endpoint}}/permissions request.

","urlObject":{"path":["groups","{{group_id}}","permissions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"04cea939-4021-4d1a-b071-2d99686edc08","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{permission_id}},\n \"type\": \"permissions\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group_id}}/permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"groups\",\"id\":\"6\",\"attributes\":{\"name\":\"ACE_Administrator\",\"description\":\"\",\"text\":\"updated text\"},\"links\":{\"self\":\"/backend/v1/groups/6\"},\"relationships\":{\"site\":{\"data\":{\"id\":43,\"type\":\"sites\"}}}}}"}],"_postman_id":"2e6db3eb-d9d4-40d4-8e22-74b028ed8dae"},{"name":"Remove Users from Groups","id":"3c9cb928-6fcd-4a48-8749-a08083ae4292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/groups/{{group_id}}/users","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`group_id`	Required The assigned ID for the group, this can be found by performing a GET {{endpoint}}/groups request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for a user, this can be found by performing a GET {{endpoint}}/users request.
`type`	\"users\"

","urlObject":{"path":["groups","{{group_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"0e4ae34b-8117-4976-892b-77f19e47135d","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group_id}}/users","description":"Remove users"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3c9cb928-6fcd-4a48-8749-a08083ae4292"},{"name":"Remove Permissions from Groups","id":"77e88d10-ed60-4b58-ad0c-921b651a5460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{permission_id}},\n \"type\": \"permissions\"\n }\n ]\n}"},"url":"{{endpoint}}/groups/{{group_id}}/permissions","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `permissions_id` The assigned ID for a permission, this can be found by performing a GET {{endpoint}}/permissions request.

","urlObject":{"path":["groups","{{group_id}}","permissions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"ab06e9ab-7bb3-4e4c-8a11-91a2235cd0ce","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{permission_id}},\n \"type\": \"permissions\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/groups/{{group_id}}/permissions","description":"Delete permissions of a group"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"77e88d10-ed60-4b58-ad0c-921b651a5460"}],"id":"018f6f49-17e8-46f5-a213-3c6e2818ce15","description":"

Groups are a method for organizing users in a compiled area. In order for groups to have appropriate ability, permissions can be assigned to the groups.

\n","event":[{"listen":"prerequest","script":{"id":"925a3625-bf6b-43e8-812d-bdc811247ccd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d82d95e9-7167-480a-9de5-2998ca23d547","type":"text/javascript","exec":[""]}}],"_postman_id":"018f6f49-17e8-46f5-a213-3c6e2818ce15"},{"name":"Objects","item":[{"name":"Retrieve All Objects","id":"f028bdb9-5020-4c80-89bd-fb5748081aa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects","description":"

Returns a list of objects used for data collection.

\n","urlObject":{"path":["objects"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1c35fbdc-4020-4271-9422-808830c1ae6e","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"objects\",\"id\":\"-6\",\"attributes\":{\"name\":\"Unit of Measure\",\"description\":\"Units that be used to track various types of measurements.\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=-6\"}},{\"type\":\"objects\",\"id\":\"-5\",\"attributes\":{\"name\":\"Resource\",\"description\":\"Resource Object\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=-5\"}},{\"type\":\"objects\",\"id\":\"-4\",\"attributes\":{\"name\":\"Address\",\"description\":\"Address Object\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=-4\"},\"relationships\":{\"parents\":{\"data\":{\"id\":[\"-1\"],\"type\":\"objects\"}}}},{\"type\":\"objects\",\"id\":\"-3\",\"attributes\":{\"name\":\"Phone\",\"description\":\"Phone Object\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=-3\"},\"relationships\":{\"parents\":{\"data\":{\"id\":[\"-1\"],\"type\":\"objects\"}}}},{\"type\":\"objects\",\"id\":\"-2\",\"attributes\":{\"name\":\"Department\",\"description\":\"Department Object\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=-2\"},\"relationships\":{\"parents\":{\"data\":{\"id\":[\"-1\"],\"type\":\"objects\"}}}},{\"type\":\"objects\",\"id\":\"-1\",\"attributes\":{\"name\":\"Company\",\"description\":\"Company Object\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=-1\"}},{\"type\":\"objects\",\"id\":\"1\",\"attributes\":{\"name\":\"ACE 1401 Object\",\"description\":\"\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=1\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/objects?page=1\"}},\"meta\":{\"totalCount\":7,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"},{"id":"7daf9079-5eb5-495b-828f-5f2d11b5aa5e","name":"Retrieve All Objects","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer LaymS34EmwsH7lcSCzRYdxdF0JZt9Y9v||LA57F1d1ZVOFSa6j11ty399cUr8ZCYuo","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 May 2022 22:58:02 GMT"},{"key":"Server","value":"Apache/2.4.52 (Unix) PHP/8.0.14"},{"key":"X-Powered-By","value":"PHP/8.0.14"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"1000"},{"key":"X-Rate-Limit-Remaining","value":"999"},{"key":"X-Rate-Limit-Reset","value":"86"},{"key":"X-Pagination-Total-Count","value":"51"},{"key":"X-Pagination-Page-Count","value":"3"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"; rel=self, ; rel=first, ; rel=last, ; rel=next"},{"key":"Set-Cookie","value":"_csrf=2de5ea6f3d298ceab406d77dacd1415cffbe0dc3faa3a000084b2467df2a812ca%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22K-PY-NCbgY7CoJxESQQtJwH8cO1oUJqv%22%3B%7D; path=/; HttpOnly; SameSite=Lax"},{"key":"Content-Length","value":"3915"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"objects\",\n \"id\": \"-12\",\n \"attributes\": {\n \"key\": \"disposition_type_object\",\n \"name\": \"Disposition Type\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-12\"\n },\n \"relationships\": {\n \"parents\": {\n \"data\": {\n \"id\": [\n \"-7\"\n ],\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-7\",\n \"attributes\": {\n \"key\": \"product_informations\",\n \"name\": \"Product Informations\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-7\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-6\",\n \"attributes\": {\n \"key\": \"unitOfMeasure\",\n \"name\": \"Unit of Measure\",\n \"description\": \"Units that be used to track various types of measurements.\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-6\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-5\",\n \"attributes\": {\n \"key\": \"resource\",\n \"name\": \"Resource\",\n \"description\": \"Resource Object\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-5\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-4\",\n \"attributes\": {\n \"key\": \"address\",\n \"name\": \"Address\",\n \"description\": \"Address Object\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-4\"\n },\n \"relationships\": {\n \"parents\": {\n \"data\": {\n \"id\": [\n \"-1\"\n ],\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-3\",\n \"attributes\": {\n \"key\": \"phone\",\n \"name\": \"Phone\",\n \"description\": \"Phone Object\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-3\"\n },\n \"relationships\": {\n \"parents\": {\n \"data\": {\n \"id\": [\n \"-1\"\n ],\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-2\",\n \"attributes\": {\n \"key\": \"department\",\n \"name\": \"Department\",\n \"description\": \"Department Object\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-2\"\n },\n \"relationships\": {\n \"parents\": {\n \"data\": {\n \"id\": [\n \"-1\"\n ],\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"-1\",\n \"attributes\": {\n \"key\": \"company\",\n \"name\": \"Company\",\n \"description\": \"Company Object\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=-1\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"2\",\n \"attributes\": {\n \"key\": \"process_id\",\n \"name\": \"Process ID\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=2\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"3\",\n \"attributes\": {\n \"key\": \"inspection_type\",\n \"name\": \"Inspection Type\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=3\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"4\",\n \"attributes\": {\n \"key\": \"product_information_object\",\n \"name\": \"Product Information\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=4\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"5\",\n \"attributes\": {\n \"key\": \"inspection_site_loca\",\n \"name\": \"Inspection Site Location\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=5\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"6\",\n \"attributes\": {\n \"key\": \"inspection_scope\",\n \"name\": \"Inspection Scope (Product)\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=6\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"7\",\n \"attributes\": {\n \"key\": \"inspecting_agency\",\n \"name\": \"Inspecting Agency\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=7\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"8\",\n \"attributes\": {\n \"key\": \"nonconforming_site\",\n \"name\": \"Nonconforming Site\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=8\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"9\",\n \"attributes\": {\n \"key\": \"failure_code\",\n \"name\": \"Failure Code\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=9\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"10\",\n \"attributes\": {\n \"key\": \"disposition_hosp\",\n \"name\": \"Disposition Hosp\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=10\"\n },\n \"relationships\": {\n \"parents\": {\n \"data\": {\n \"id\": [\n \"11\"\n ],\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"11\",\n \"attributes\": {\n \"key\": \"classification\",\n \"name\": \"Classification\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=11\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"12\",\n \"attributes\": {\n \"key\": \"hospira_product_types\",\n \"name\": \"Hospira Product Types\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=12\"\n }\n },\n {\n \"type\": \"objects\",\n \"id\": \"13\",\n \"attributes\": {\n \"key\": \"hospira_products\",\n \"name\": \"Hospira Products\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/objects/view?id=13\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/objects?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v1/objects?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v1/objects?page=3\"\n },\n \"next\": {\n \"href\": \"/backend/v1/objects?page=2\"\n }\n },\n \"meta\": {\n \"totalCount\": 51,\n \"pageCount\": 3,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"f028bdb9-5020-4c80-89bd-fb5748081aa5"},{"name":"Retrieve an Object","id":"69f2f432-4b8f-43e4-91d8-9a94e17836e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}","description":"

Returns details about a given Object.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

","urlObject":{"path":["objects","{{object_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5f3b6ab2-a675-4f77-81d4-22f07b459644","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}","description":"Search groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"objects\",\"id\":\"-6\",\"attributes\":{\"name\":\"Unit of Measure\",\"description\":\"Units that be used to track various types of measurements.\"}}}"}],"_postman_id":"69f2f432-4b8f-43e4-91d8-9a94e17836e7"},{"name":"Retrieve Fields in Objects","id":"8260aa4b-f695-4a94-abe2-2b0ccab6b6b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/fields","description":"

Return a list of fields configured to a data Object.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

","urlObject":{"path":["objects","{{object_id}}","fields"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"91bc0092-5026-43e6-8e0f-9c67f9d2e4de","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"custom-fields\",\"id\":\"23\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 Name\",\"description\":\"\",\"name\":\"cf_ace_1401_name\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":\"\",\"currency_symbol\":\"$\",\"number_of_decimals\":\"2\",\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null,\"lockRecord\":false},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/23\"}},{\"type\":\"custom-fields\",\"id\":\"24\",\"attributes\":{\"fieldType\":\"textarea\",\"label\":\"ACE 1401 Description\",\"description\":\"\",\"name\":\"cf_ace_1401_description\",\"tooltip\":null,\"data\":{\"max\":\"65535\",\"field_size\":\"input-block-level\",\"field_id\":false,\"customAttributeLabels\":null,\"lockRecord\":false},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/24\"}},{\"type\":\"custom-fields\",\"id\":\"25\",\"attributes\":{\"fieldType\":\"multiPicker\",\"label\":\"ACE 1401 MOP (User | None)\",\"description\":\"\",\"name\":\"cf_ace_1401_mop_user_none\",\"tooltip\":null,\"data\":{\"modelClass\":\"user\",\"insert\":null,\"object_id\":\"\",\"parent_object_id\":\"\",\"filter\":false,\"filter_value\":false,\"data_filter_type\":\"none\",\"role_type\":false,\"model_type\":false,\"record_lock\":null,\"record_columns\":\"pkey|title|project_id|initiator_id|status_id\",\"column\":null,\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null,\"lockRecord\":false},\"datatype\":\"user\",\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/25\"}},{\"type\":\"custom-fields\",\"id\":\"26\",\"attributes\":{\"fieldType\":\"datepicker\",\"label\":\"ACE 1401 Date Picker\",\"description\":\"mm/dd/yyyy\",\"name\":\"cf_ace_1401_date_picker\",\"tooltip\":null,\"data\":{\"format\":\"mm/dd/yyyy\",\"displayFormat\":\"\",\"weekStart\":0,\"viewMode\":\"days\",\"minViewMode\":\"days\",\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null,\"lockRecord\":false},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/26\"}},{\"type\":\"custom-fields\",\"id\":\"27\",\"attributes\":{\"fieldType\":\"textfield\",\"label\":\"ACE 1401 Text Field 2\",\"description\":\"\",\"name\":\"cf_ace_1401_text_field_2\",\"tooltip\":null,\"data\":{\"max\":\"255\",\"validation_type\":\"\",\"regular_expression\":\"\",\"currency_symbol\":\"$\",\"number_of_decimals\":\"2\",\"field_size\":\"input-xlarge\",\"field_id\":false,\"customAttributeLabels\":null,\"lockRecord\":false},\"datatype\":null,\"objectUrl\":null,\"module\":\"object\"},\"links\":{\"self\":\"/backend/v1/custom-fields/27\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/objects/1/fields?page=1\"}},\"meta\":{\"totalCount\":5,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"8260aa4b-f695-4a94-abe2-2b0ccab6b6b5"},{"name":"Retrieve Field Info in Objects","id":"2260e209-b3bd-462f-a1aa-4132f3576e6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/fields/info","description":"

List details of fields that are configured to record information regarding a specific object.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

","urlObject":{"path":["objects","{{object_id}}","fields","info"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"37742ecd-9fe3-45e5-ada0-256bea5df75d","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/fields/info","description":"Search groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"object-custom-fields\",\"id\":\"-17\",\"attributes\":{\"required\":false,\"unique\":false,\"displayed\":true,\"position\":2},\"relationships\":{\"custom-field\":{\"data\":{\"id\":-41,\"type\":\"custom-fields\"}}}},{\"type\":\"object-custom-fields\",\"id\":\"-16\",\"attributes\":{\"required\":true,\"unique\":true,\"displayed\":true,\"position\":1},\"relationships\":{\"custom-field\":{\"data\":{\"id\":-40,\"type\":\"custom-fields\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/objects/-6/fields/info?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"2260e209-b3bd-462f-a1aa-4132f3576e6d"},{"name":"Retrieve Object Records","id":"2cb93782-68cf-4174-8919-a7389cd9d42d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/records","description":"

Returns data stored for a given Object.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

","urlObject":{"path":["objects","{{object_id}}","records"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"87f14992-e758-49cf-b1b9-29e75da115cc","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/records","description":"Search groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"object-records\",\n \"id\": \"1\",\n \"attributes\": {\n \"text\": \"Each EA\",\n \"name\": \"fb33b0f4-c051-4f15-9a44-3adbbdad2e04\",\n \"cf_uom_name\": \"Each\",\n \"cf_uom_abbreviation\": \"EA\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/objects/-6/records?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 19,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"2cb93782-68cf-4174-8919-a7389cd9d42d"},{"name":"Search Objects","id":"46539b68-4438-41f6-b9cf-e01a2ff44bee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"SELECT id, name FROM __main__\"\n}"},"url":"{{endpoint}}/objects/{{object_id}}/search","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

","urlObject":{"path":["objects","{{object_id}}","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"eb63b98f-4edd-4192-9531-2b54be5a80d2","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}/records","description":"Search groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"object-records\",\n \"id\": \"1\",\n \"attributes\": {\n \"text\": \"Each EA\",\n \"name\": \"fb33b0f4-c051-4f15-9a44-3adbbdad2e04\",\n \"cf_uom_name\": \"Each\",\n \"cf_uom_abbreviation\": \"EA\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/objects/-6/records?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 19,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"46539b68-4438-41f6-b9cf-e01a2ff44bee"},{"name":"Create Objects","id":"56fe75d1-ac38-4e7a-a60c-08cc7db4c41c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"objects\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Object 2\",\n \"key\": \"ace1401postmanobject\",\n \"description\": \"ACE 1401 Postman Object Description\"\n }\n }\n}"},"url":"{{endpoint}}/objects","description":"

The available attributes for the object are defined by an ACE System Administrator and configured within ACE. Specific attribute ids can be requested via GET /objects/{objectID}/fields.

Body Parameters (For all object types.)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`name`	Required Name of the object *`name` must be unique
`key`	Required A unique, abbreviated letter combination to represent the object *`key` must be unique and must match this regex pattern: '/^[a-z_0-9]+$/
`description`	Optional Detailed description of the object

","urlObject":{"path":["objects"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"6c7ee484-6a83-48d9-8f56-15620023a05f","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\":\n\t{\n\t\t\"type\":\"objects\",\n\t\t\"attributes\":\n\t\t{\n\t\t\t\"name\":\"ACE 1401 Postman Object 2\",\n\t\t\t\"key\":\"ace1401postmanobject\",\n\t\t\t\"description\":\"ACE 1401 Postman Object Description\"\n\t\t}\n\t}\n}"},"url":"{{endpoint}}/objects"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"objects\",\"id\":\"5\",\"attributes\":{\"name\":\"ACE 1401 Postman Object 2\",\"description\":\"ACE 1401 Postman Object Description\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=5\"}}}"}],"_postman_id":"56fe75d1-ac38-4e7a-a60c-08cc7db4c41c"},{"name":"Add Records to Objects","id":"e0d49d4a-32d0-4c91-bee9-501772bfec89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"object-records\",\n \"attributes\": {\n \"cf_ace_1401_name\": \"test6\",\n \"cf_ace_1401_description\": \"test8\",\n \"cf_ace_1401_mop_user_none\": [\n 1\n ],\n }\n },\n {\n \"type\": \"object-records\",\n \"attributes\": {\n \"cf_uom_name\": \"test3\",\n \"cf_uom_abbreviation\": \"test7\"\n }\n }\n ]\n}"},"url":"{{endpoint}}/objects/{{object_id}}/records","description":"

Insert data into a given Object.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`attributes`	Attributes for each object record is based off of the configured object fields. Specific attribute ids can be requested via GET /objects/{objectID}/fields.

","urlObject":{"path":["objects","{{object_id}}","records"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0d49d4a-32d0-4c91-bee9-501772bfec89"},{"name":"Update Objects","id":"c3aa52d2-309e-4a5c-8eae-185081f0a0d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"objects\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Object 2 EDIT\",\n \"key\": \"ace1401postmanobject2\",\n \"description\": \"ACE 1401 Postman Object Description\"\n }\n }\n}"},"url":"{{endpoint}}/objects/{{object_id}}","description":"

The available attributes for the object are defined by an ACE System Administrator and configured within ACE. Specific attribute ids can be requested via GET /objects/{objectID}/fields.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

Body Parameters (For all object types.)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"objects\"
`name`	Required Name of the object *`name` must be unique
`key`	Required A unique, abbreviated letter combination to represent the object *`key` must be unique and must match this regex pattern: '/^[a-z_0-9]+$/
`description`	Optional Detailed description of the object

","urlObject":{"path":["objects","{{object_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5b13b844-0bd8-4e87-a344-2a359cc6c854","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"objects\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Object 2 EDIT\",\n \"key\": \"ace1401postmanobject2\",\n \"description\": \"ACE 1401 Postman Object Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/objects/{{object_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"objects\",\"id\":\"5\",\"attributes\":{\"name\":\"ACE 1401 Postman Object 2 EDIT\",\"description\":\"ACE 1401 Postman Object Description\"},\"links\":{\"self\":\"/backend/v1/objects/view?id=5\"}}}"}],"_postman_id":"c3aa52d2-309e-4a5c-8eae-185081f0a0d3"},{"name":"Update Record in Objects","id":"f9d8ca5d-cad7-4253-ba91-00249a9d69f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"object-records\",\n \"id\": \"73\",\n \"attributes\": {\n \"cf_uom_name\": \"test9\",\n \"cf_uom_abbreviation\": \"test10\",\n \"cf_a_test_cf\": \"new vvalue\"\n }\n },\n {\n \"type\": \"object-records\",\n \"id\": \"74\",\n \"attributes\": {\n \"cf_uom_name\": \"test11\",\n \"cf_uom_abbreviation\": \"test12\",\n \"cf_a_test_cf\": \"new value2\"\n }\n }\n ]\n}"},"url":"{{endpoint}}/objects/{{object_id}}/records","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required ID of the records being modified
`attributes`	Attributes for each object record is based off of the configured object fields. Specific attribute ids can be requested via GET /objects/{objectID}/fields.

","urlObject":{"path":["objects","{{object_id}}","records"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3951242c-6704-4c86-b5da-f4c7f606e167","name":"Successful response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"object-records\",\n \"id\": \"73\",\n \"attributes\": {\n \"cf_uom_name\": \"test9\",\n \"cf_uom_abbreviation\": \"test10\",\n \"cf_a_test_cf\": \"new vvalue\"\n }\n },\n {\n \"type\": \"object-records\",\n \"id\": \"74\",\n \"attributes\": {\n \"cf_uom_name\": \"test11\",\n \"cf_uom_abbreviation\": \"test12\",\n \"cf_a_test_cf\": \"new value2\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/objects/{{object_id}}/records","description":"Update multiple objects.\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"object-records\",\"id\":\"73\",\"attributes\":{\"text\":\"test9 test10 new vvalue\",\"name\":\"76c89f4e-362e-3104-b938-c1bda5201258\",\"cf_uom_name\":\"test9\",\"cf_uom_abbreviation\":\"test10\",\"cf_a_test_cf\":\"new vvalue\"}},{\"type\":\"object-records\",\"id\":\"74\",\"attributes\":{\"text\":\"test11 test12 new value2\",\"name\":\"b0c1b268-90b3-30f1-bd6d-f6337827406a\",\"cf_uom_name\":\"test11\",\"cf_uom_abbreviation\":\"test12\",\"cf_a_test_cf\":\"new value2\"}}]}"}],"_postman_id":"f9d8ca5d-cad7-4253-ba91-00249a9d69f1"},{"name":"Delete Objects","id":"03820afa-3937-4092-a0b1-f6d09b3811c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`object_id`	Required The assigned ID for the object, this can be found by performing a GET {{endpoint}}/objects request.

","urlObject":{"path":["objects","{{object_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"fa0b448f-d649-4bf5-a6fa-2e8b2248d4ec","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/objects/{{object_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"03820afa-3937-4092-a0b1-f6d09b3811c6"}],"id":"68a51c52-a36f-4711-aa14-f19dd4ec1fa1","description":"

Objects are versatile sets of data that can be used to describe locations, companies, departments, contact information, and much more. Objects can also be used in forms to insert preconfigured content into other custom fields.

\n","event":[{"listen":"prerequest","script":{"id":"053e18d9-0857-44fb-84be-567f78761a53","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"77728fa4-5aa4-476c-8944-87ef0859bfcd","type":"text/javascript","exec":[""]}}],"_postman_id":"68a51c52-a36f-4711-aa14-f19dd4ec1fa1"},{"name":"Permissions","item":[{"name":"Retrieve All Permissions","id":"231b12b7-e17a-4caf-8776-8533511df9ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/permissions","description":"

Returns a list of all permissions.

\n","urlObject":{"path":["permissions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"62c5537f-fab0-444f-9d66-54caa17eb230","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/permissions","description":"Permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"permissions\",\"id\":\"24\",\"attributes\":{\"name\":\"global_admin\",\"description\":\"Ability to perform most user & group administration functions.
Note: People with this permission can always log in.\",\"text\":\"Administrators\"}},{\"type\":\"permissions\",\"id\":\"65\",\"attributes\":{\"name\":\"global_api\",\"description\":\"ACE API\",\"text\":\"API\"}},{\"type\":\"permissions\",\"id\":\"25\",\"attributes\":{\"name\":\"global_browseUser\",\"description\":\"Ability to select a user or group from a popup window. Users with this permission will be able to see names of all users and groups in the system.\",\"text\":\"Browse Users\"}},{\"type\":\"permissions\",\"id\":\"26\",\"attributes\":{\"name\":\"global_bulkChange\",\"description\":\"Ability to modify a collection of records at once.\",\"text\":\"Bulk Change\"}},{\"type\":\"permissions\",\"id\":\"27\",\"attributes\":{\"name\":\"global_createSharedObjects\",\"description\":\"Ability to share data such as calendars, dashboards and filters with other users.\",\"text\":\"Create Shared Objects\"}},{\"type\":\"permissions\",\"id\":\"28\",\"attributes\":{\"name\":\"global_sysadmin\",\"description\":\"Ability to perform all administration functions. There must be at least one group with this permission.
Note: People with this permission can always log in.\",\"text\":\"System Administrators\"}},{\"type\":\"permissions\",\"id\":\"29\",\"attributes\":{\"name\":\"global_user\",\"description\":\"Ability to log in to the system. All users need this permission to be able to log in, even if they have other permissions.\",\"text\":\"Users\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/permissions?page=1\"}},\"meta\":{\"totalCount\":7,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"231b12b7-e17a-4caf-8776-8533511df9ea"}],"id":"78b13b11-610a-4241-a095-c98237704fe5","description":"

Permissions are used to give users and groups appropriate ability.

\n","event":[{"listen":"prerequest","script":{"id":"0e1a448b-edcf-4543-ba2b-5fbeae67424c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b7b30eba-9a84-43de-bb8c-89a5b6c3eb51","type":"text/javascript","exec":[""]}}],"_postman_id":"78b13b11-610a-4241-a095-c98237704fe5"},{"name":"Persons","item":[{"name":"Retrieve All People","id":"eed83427-12cd-4d9f-9571-afeb7d4dcbec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people","description":"

Returns a list of all people.

\n","urlObject":{"path":["people"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bca4a49d-d318-40d1-a01f-c3e11e018b90","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": \"1\",\n \"attributes\": {\n \"avatar_color\": 1,\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"email\": \"email@domain.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"FL\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/people?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/people?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/people?page=31\"\n }\n },\n \"meta\": {\n \"totalCount\": 615,\n \"pageCount\": 31,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"eed83427-12cd-4d9f-9571-afeb7d4dcbec"},{"name":"Retrieve a Person","id":"aa46f495-7855-4bbd-9669-a9418b880212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people/{{person_id}}","description":"

Returns details on a given person.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

","urlObject":{"path":["people","{{person_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"12b63f12-54d4-45e8-9594-b68d3a6e0ebe","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people/{{person_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"people\",\"id\":\"4\",\"attributes\":{\"avatar_color\":8,\"first_name\":\"Pester\",\"last_name\":\"Tester\",\"email\":\"ptester123@biotech.com\",\"avatar\":\"\",\"avatar_initials\":\"PT\"}}}"}],"_postman_id":"aa46f495-7855-4bbd-9669-a9418b880212"},{"name":"Retrieve a Persons Categories","id":"76c1ac63-1104-401f-b06f-e8dcf6a9e019","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people/{{person_id}}/categories","description":"

Returns a list of categories that a given person is assoicated to.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

","urlObject":{"path":["people","{{person_id}}","categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e55b3a0e-81e3-40df-9db7-c578a11ff3fb","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people/{{person_id}}/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"person-categories\",\"id\":\"1\",\"attributes\":{\"name\":\"Testing\",\"desc\":\"Description\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/people/634/categories?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"76c1ac63-1104-401f-b06f-e8dcf6a9e019"},{"name":"Retrieve a Persons Managers","id":"be2c6335-ba8d-4158-9f3a-b4cbab467e7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people/{{person_id}}/managers","description":"

Returns a list of managers that a given person is assoicated with.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

","urlObject":{"path":["people","{{person_id}}","managers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"04f65f4c-3f0a-4f4c-95e8-f455a798882b","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/people/{{person_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": \"1\",\n \"attributes\": {\n \"avatar_color\": 1,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"email\": \"testuser@email.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"TU\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/people/634/managers?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"be2c6335-ba8d-4158-9f3a-b4cbab467e7d"},{"name":"Create Person","id":"2e3c397f-d652-424e-9ad3-5d3d27334ab1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\":\n\t{\n\t\t\"type\":\"people\",\n\t\t\"attributes\":\n\t\t{\n\t\t\t\"first_name\":\"test2\",\n\t\t\t\"last_name\":\"test2\", \n\t\t\t\"m_initial\":\"a\",\n\t\t\t\"job_title\":\"string\",\n\t\t\t\"email\":\"test4@email.com\"\n\t\t}\n\t\t\n\t}\n\t\n}"},"url":"{{endpoint}}/people","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`first_name`	Required First name of the new person.
`last_name`	Required Last name of the new person.
`email`	Optional Email address of the new person. *Must be unique
`m_initial`	Optional Middle initial of the new person. *Must be a string with length = 1
`job_title`	Optional The job title of the new person.
`avatar`	Optional Avatar of the new person.
`avatar_color`	Optional Color of the avatar.
`avatar_initials`	Optional Initials shown on avatar.

","urlObject":{"path":["people"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"8c1dcbb2-d158-45d6-b871-6c303d492a76","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"people\",\n \"attributes\": {\n \"first_name\": \"test1\",\n \"last_name\": \"test2\",\n \"email\": \"test4@email.com\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"people\",\n \"id\": \"14\",\n \"attributes\": {\n \"avatar_color\": null,\n \"first_name\": \"test1111\",\n \"last_name\": \"test2\",\n \"email\": \"test4@email.com\",\n \"avatar\": null,\n \"avatar_initials\": \"Tt\"\n },\n \"links\": {\n \"self\": \"/backend/v1/people/14\"\n }\n }\n}"}],"_postman_id":"2e3c397f-d652-424e-9ad3-5d3d27334ab1"},{"name":"Add Categories to Person","id":"b961b933-691d-43a2-b435-1f5fe48374eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"person-categories\",\n \"id\": 1\n }\n ]\n}"},"url":"{{endpoint}}/people/{{person_id}}/categories","description":"

Add categories to a person if none of the categories were already assigned to the person. Replaces existing categories if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"person-categories\"
`id`	Required `category_id` The assigned ID for the category, this can be found by performing a GET {{endpoint}}/person-categories request.

","urlObject":{"path":["people","{{person_id}}","categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5a6cf9f7-afc3-4b2b-84b9-f410c4b271a8","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"person-categories\",\n \"id\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people/{{person_id}}/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"person-categories\",\"id\":\"1\",\"attributes\":{\"name\":\"Testing\",\"desc\":\"Description\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/people/634/categories?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"b961b933-691d-43a2-b435-1f5fe48374eb"},{"name":"Add Managers to Person","id":"8b9639cd-dc5b-4f5a-a563-bf01fac666ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": 1\n },\n {\n \"type\": \"people\",\n \"id\": 2\n }\n ]\n}"},"url":"{{endpoint}}/people/{{person_id}}/managers","description":"

Add manager(s) to a person if none of the manager(s) were already assigned to the person. Replaces existing managers if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"people\"
`id`	Required `person_id` The assigned ID for the manager, this can be found by performing a GET {{endpoint}}/people request.

","urlObject":{"path":["people","{{person_id}}","managers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"33b7128f-900a-4c2b-853d-dafb4de93062","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": 1\n },\n {\n \"type\": \"people\",\n \"id\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people/{{person_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": \"1\",\n \"attributes\": {\n \"avatar_color\": 1,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"email\": \"testuser@email.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"MT\"\n }\n },\n {\n \"type\": \"people\",\n \"id\": \"2\",\n \"attributes\": {\n \"avatar_color\": 7,\n \"first_name\": \"Test\",\n \"last_name\": \"User 2\",\n \"email\": \"testuser2@email.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"KH\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/people/634/managers?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"8b9639cd-dc5b-4f5a-a563-bf01fac666ec"},{"name":"Update Person","id":"343df269-e9ae-47de-8bed-e88870dba393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"people\",\n \"id\": 1,\n \"attributes\": {\n \"first_name\": \"test1\",\n \"last_name\": \"test2\"\n }\n }\n}"},"url":"{{endpoint}}/people/{{person_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`first_name`	Required First name of the person.
`last_name`	Required Last name of the person.
`email`	Optional Email address of the person. *Must be unique
`m_initial`	Optional Middle initial of the person. *Must be a string with length = 1
`job_title`	Optional The job title of the person.
`avatar`	Optional Avatar of the person.
`avatar_color`	Optional Color of the avatar.
`avatar_initials`	Optional Initials shown on avatar.

","urlObject":{"path":["people","{{person_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"0f247784-df05-464a-84eb-9b32d875f9bd","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"people\",\"id\":1, \"attributes\":{\"first_name\":\"test1\",\"last_name\":\"test2\"}}}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people/{{person_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"people\",\"id\":\"634\",\"attributes\":{\"avatar_color\":null,\"first_name\":\"test1\",\"last_name\":\"test2\",\"email\":\"testing@domain.com\",\"avatar\":\"\",\"avatar_initials\":\"Tt\"}}}"}],"_postman_id":"343df269-e9ae-47de-8bed-e88870dba393"},{"name":"Update Person Categories","id":"7201cfec-8cbd-4f1f-9dc9-c20b803c90c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"person-categories\",\n \"id\": 1\n }\n ]\n}"},"url":"{{endpoint}}/people/{{person_id}}/categories","description":"

Adds categories to the person if none of the selected categories are already assigned to the person. Appends to existing categories if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"person-categories\"
`id`	Required `category_id` The assigned ID for the category, this can be found by performing a GET {{endpoint}}/person-categories request.

","urlObject":{"path":["people","{{person_id}}","categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"68bf4632-b44c-4145-8cae-5f6d6845a361","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"person-categories\",\n \"id\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people/{{person_id}}/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"person-categories\",\"id\":\"1\",\"attributes\":{\"name\":\"Testing\",\"desc\":\"Description\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/people/634/categories?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"7201cfec-8cbd-4f1f-9dc9-c20b803c90c8"},{"name":"Update Person Managers","id":"10aaab78-d845-4a51-a1d6-5f0daec85357","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": 1\n },\n {\n \"type\": \"people\",\n \"id\": 2\n },\n {\n \"type\": \"people\",\n \"id\": 3\n }\n ]\n}"},"url":"{{endpoint}}/people/{{person_id}}/managers","description":"

Adds manager(s) to the person if none of the selected manager(s) are already assigned to the person. Appends to existing managers if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"people\"
`id`	Required `person_id` The assigned ID for the manager, this can be found by performing a GET {{endpoint}}/people request.

","urlObject":{"path":["people","{{person_id}}","managers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bc538aae-0fc5-497e-9fbe-3d86ef47baa7","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": 1\n },\n {\n \"type\": \"people\",\n \"id\": 2\n },\n {\n \"type\": \"people\",\n \"id\": 3\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people/{{person_id}}/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"people\",\n \"id\": \"1\",\n \"attributes\": {\n \"avatar_color\": 1,\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"email\": \"testuser@email.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"MT\"\n }\n },\n {\n \"type\": \"people\",\n \"id\": \"2\",\n \"attributes\": {\n \"avatar_color\": 7,\n \"first_name\": \"Test\",\n \"last_name\": \"User 2\",\n \"email\": \"testuser2@email.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"KH\"\n }\n },\n {\n \"type\": \"people\",\n \"id\": \"3\",\n \"attributes\": {\n \"avatar_color\": 8,\n \"first_name\": \"Test\",\n \"last_name\": \"User 3\",\n \"email\": \"testuser3@email.com\",\n \"avatar\": \"\",\n \"avatar_initials\": \"LD\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/people/634/managers?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"10aaab78-d845-4a51-a1d6-5f0daec85357"},{"name":"Delete Person","id":"b0379c81-132a-4870-9b8c-106adef92c0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/people/{{person_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

","urlObject":{"path":["people","{{person_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9cb8429c-1798-4b82-8351-c27c7ca44180","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/people/{{person_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b0379c81-132a-4870-9b8c-106adef92c0d"},{"name":"Remove a Person Categories","id":"f735d2af-9f78-407d-9968-27bb054ccaa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"person-categories\",\n \"id\": 1\n }\n ]\n}"},"url":"{{endpoint}}/people/{{person_id}}/categories","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`person_id`	Required The assigned ID for the person, this can be found by performing a GET {{endpoint}}/people request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"person-categories\"
`id`	Required `category_id` The assigned ID for the category, this can be found by performing a GET {{endpoint}}/person-categories request.

","urlObject":{"path":["people","{{person_id}}","categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"40d90518-42f1-4ae2-8278-a2de2e1b0534","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"person-categories\",\n \"id\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/people/{{person_id}}/categories"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":""}],"_postman_id":"f735d2af-9f78-407d-9968-27bb054ccaa7"}],"id":"e831885d-1872-460d-8f1a-5957f9ed87b2","description":"

Persons keep track of users and non-users in the system. All users must have a person associated to their account. Persons can also exist in the system without belonging to a user account. For example, persons are used to keep track of inspectors/auditors who do not have access to the ACE system, but still need to be documented.

\n","event":[{"listen":"prerequest","script":{"id":"23be3e47-17d3-4b5a-8222-57e2b169cf42","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fced51e5-bdb0-4ae9-8ff8-cc3e9819a039","type":"text/javascript","exec":[""]}}],"_postman_id":"e831885d-1872-460d-8f1a-5957f9ed87b2"},{"name":"Person Categories","item":[{"name":"Retrieve All Person Categories","id":"0c66a06f-7c78-4f53-a133-b30cc3bfc4b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/person-categories","description":"

Returns a list of categories used for person data.

\n","urlObject":{"path":["person-categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"8e762304-e114-4ecc-9586-02d2b0b657d1","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/person-categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"person-categories\",\"id\":\"1\",\"attributes\":{\"name\":\"Testing\",\"desc\":\"Description\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/person-categories?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"0c66a06f-7c78-4f53-a133-b30cc3bfc4b6"},{"name":"Create Person Categories","id":"49acbd74-d0c1-4bc2-9052-8c2000725c1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\":\"person-categories\",\n\t\t\"attributes\": {\n\t\t\t\"name\":\"Testing\",\n\t\t\t\"desc\": \"Description\"\n\t\t}\n\t}\n}"},"url":"{{endpoint}}/person-categories","urlObject":{"path":["person-categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"f3ec18c0-0ea7-4c66-b52b-fe9deed17ba4","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"person-categories\",\n \"attributes\": {\n \"name\": \"Testing\",\n \"desc\": \"Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/person-categories"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"person-categories\",\"id\":\"1\",\"attributes\":{\"name\":\"Testing\",\"desc\":\"Description\"}}}"}],"_postman_id":"49acbd74-d0c1-4bc2-9052-8c2000725c1b"},{"name":"Update Person Categories","id":"d6748d29-35f8-40e6-9d98-e03fb8606e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"person-categories\",\n \"attributes\": {\n \"name\": \"New Name\",\n \"desc\": \"Description Edit\"\n }\n }\n}"},"url":"{{endpoint}}/person-categories/{{category_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`category_id`	Required The assigned ID for the category, this can be found by performing a GET {{endpoint}}/person-categories request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"person-categories\"
`name`	Required The name of the category *`name` must be unique
`desc`	Optional Description of the person category.

","urlObject":{"path":["person-categories","{{category_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b02625ae-e2b1-4ce1-901f-9729a63708d1","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"person-categories\",\n \"attributes\": {\n \"name\": \"Testing EDIT\",\n \"desc\": \"Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/person-categories/{{category_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"person-categories\",\"id\":\"2\",\"attributes\":{\"name\":\"Testing EDIT\",\"desc\":\"Description EDIT\"}}}"}],"_postman_id":"d6748d29-35f8-40e6-9d98-e03fb8606e25"},{"name":"Delete Person Categories","id":"26c88b4e-0665-498e-9cab-86317928f986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/person-categories/{{category_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`category_id`	Required The assigned ID for the category, this can be found by performing a GET {{endpoint}}/person-categories request.

","urlObject":{"path":["person-categories","{{category_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bf4fa4e8-ef33-4eb4-a1ed-bb10d42b7a31","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/person-categories/{{category_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"26c88b4e-0665-498e-9cab-86317928f986"}],"id":"04b08573-5b47-4da5-9b99-17ae3fb73abd","description":"

Person category is a method for organizing persons into a compiled area.

\n","event":[{"listen":"prerequest","script":{"id":"ac65174f-4e0b-4d20-a1eb-4c73295ddb97","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b900aa12-1a1e-4af0-8c73-041a8e874c30","type":"text/javascript","exec":[""]}}],"_postman_id":"04b08573-5b47-4da5-9b99-17ae3fb73abd"},{"name":"Projects","item":[{"name":"Retrieve All Projects","id":"7c926bd2-0b25-4757-a32d-852fb66c4bc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/projects","description":"

Returns a list of all projects.

\n","urlObject":{"path":["projects"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"4fec8ca5-d095-4e95-8168-c2a173b8cddb","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/projects","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Medical Review Form\",\n \"desc\": \"\",\n \"pkey\": \"MRF\",\n \"is_parent\": true\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/projects?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 6,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"7c926bd2-0b25-4757-a32d-852fb66c4bc8"},{"name":"Retrieve Children to Projects","id":"f68138f4-4876-45eb-82e4-e0936240c05b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/projects/{{project_id}}/children","description":"

Returns a list of all child projects for a given project.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_id`	Required The assigned ID for the parent project, this can be found by performing a GET {{endpoint}}/projects request.

","urlObject":{"path":["projects","{{project_id}}","children"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"4be50c3f-1753-45b8-b865-b9f43db72309","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/projects/{{project_id}}/children","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [ {\n \"type\": \"projects\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Medical Review Form\",\n \"desc\": \"\",\n \"pkey\": \"MRF\",\n \"is_parent\": true\n }\n }],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/projects/1/children?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"f68138f4-4876-45eb-82e4-e0936240c05b"},{"name":"Search Projects","id":"1f75474d-d607-4356-a096-549a8013e70d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, name, description from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/projects/search","description":"

Returns a list of projects.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["projects","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"801b644e-5b77-4547-bb7d-97e8b7b4ccb1","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/projects/search","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Medical Review Form\",\n \"desc\": \"\",\n \"pkey\": \"MRF\",\n \"is_parent\": true\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/projects/search?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 6,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"1f75474d-d607-4356-a096-549a8013e70d"},{"name":"Add Children To Projects","id":"0dbea262-2901-4f0b-bf06-e857916f7d1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": 9\n }\n ]\n}"},"url":"{{endpoint}}/projects/{{project_id}}/children","description":"

Add child(ren) to a project if none of the child(ren) were already assigned to the project. Replaces existing child(ren) if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_id`	Required The assigned ID for the parent project, this can be found by performing a GET {{endpoint}}/projects request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"projects\"
`id`	Required `project_id` The assigned ID for the child project, this can be found by performing a GET {{endpoint}}/projects request.

","urlObject":{"path":["projects","{{project_id}}","children"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"ba6fe34c-2e8b-4d9e-bea4-4704f1e728bd","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": 9\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/projects/{{project_id}}/children","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"projects\",\"id\":\"2\",\"attributes\":{\"name\":\"Controlled Document\",\"desc\":\"\",\"pkey\":\"DOC\",\"is_parent\":true},\"relationships\":{\"leader\":{\"data\":{\"id\":-1,\"type\":\"users\"}},\"parent\":{\"data\":{\"id\":\"1\",\"type\":\"projects\"}}}},{\"type\":\"projects\",\"id\":\"9\",\"attributes\":{\"name\":\"Temperature Excursion\",\"desc\":\"\",\"pkey\":\"TE\",\"is_parent\":true},\"relationships\":{\"parent\":{\"data\":{\"id\":\"1\",\"type\":\"projects\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/projects/1/children?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"0dbea262-2901-4f0b-bf06-e857916f7d1c"},{"name":"Update Children to Projects","id":"e176a211-16d3-4276-9fee-e2f5aa0408a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": 2\n }\n ]\n}"},"url":"{{endpoint}}/projects/{{project_id}}/children","description":"

Adds child(ren) to the project if none of the selected child(ren) are already assigned to the project. Appends to existing child(ren) if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_id`	Required The assigned ID for the parent project, this can be found by performing a GET {{endpoint}}/projects request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"projects\"
`id`	Required `project_id` The assigned ID for the child project, this can be found by performing a GET {{endpoint}}/projects request.

","urlObject":{"path":["projects","{{project_id}}","children"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"357c789c-7de5-46b0-84ec-6db3990746a7","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/projects/{{project_id}}/children"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"projects\",\"id\":\"2\",\"attributes\":{\"name\":\"Controlled Document\",\"desc\":\"\",\"pkey\":\"DOC\",\"is_parent\":true},\"relationships\":{\"leader\":{\"data\":{\"id\":-1,\"type\":\"users\"}},\"parent\":{\"data\":{\"id\":\"1\",\"type\":\"projects\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/projects/1/children?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"e176a211-16d3-4276-9fee-e2f5aa0408a7"},{"name":"Remove Children from Projects","id":"820e2dcf-84ce-440d-b815-acb666b239e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": 45\n }\n ]\n}"},"url":"{{endpoint}}/projects/{{project_id}}/children","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_id`	Required The assigned ID for the parent project, this can be found by performing a GET {{endpoint}}/projects request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"projects\"
`id`	Required `project_id` The assigned ID for the child project, this can be found by performing a GET {{endpoint}}/projects request.

","urlObject":{"path":["projects","{{project_id}}","children"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"056ade6b-032d-47a9-bc0d-f76ff703847f","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"projects\",\n \"id\": 9\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/projects/{{project_id}}/children","description":"Search custom fields"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"820e2dcf-84ce-440d-b815-acb666b239e4"}],"id":"fdca5ac9-7197-4300-9f34-fff3406a7cbe","description":"

A project is a tool for compiling and managing all applicable configurations used in order to produce a record within ACE. There are parent project and child project capable within ACE:

Parent project: A project that does not need to be linked to another project in order to create a record.
Child project: A project that is dependent on its Parent project. A child record cannot be created without a parent project being used to create a record.

\n","event":[{"listen":"prerequest","script":{"id":"14a8e1d4-4128-44b3-9f54-7864914658cf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"18589c57-ef64-4644-806f-be89b31666fa","type":"text/javascript","exec":[""]}}],"_postman_id":"fdca5ac9-7197-4300-9f34-fff3406a7cbe"},{"name":"Project Categories","item":[{"name":"Retrieve All Project Categories","id":"5b5e2ea3-cc95-4c9d-b184-6e53d6f82e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/project-categories","description":"

Returns a list of all project categories.

\n","urlObject":{"path":["project-categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9263f50c-5aea-4d5f-911e-daf0d4f163e9","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/project-categories","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"project-categories\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Testing\",\n \"desc\": \"Testing\"\n }\n },\n {\n \"type\": \"project-categories\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"Testing 2\",\n \"desc\": \"Testing 2\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/project-categories?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"5b5e2ea3-cc95-4c9d-b184-6e53d6f82e9a"},{"name":"Create Project Categories","id":"9a6e0bf7-8a3a-43a4-924f-d738d4f54618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-categories\",\n \"attributes\": {\n \"name\": \"Testing\",\n \"desc\": \"Testing\"\n }\n }\n}"},"url":"{{endpoint}}/project-categories","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"project-categories\"
`name`	Required Name of the project category. *Must be unique
`desc`	Optional Description of the project category.

","urlObject":{"path":["project-categories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9b8d318d-c48e-482e-8f54-85752cb34e28","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-categories\",\n \"attributes\": {\n \"name\": \"Testing\",\n \"desc\": \"Testing\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-categories","description":"Search custom fields"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"project-categories\",\"id\":\"3\",\"attributes\":{\"name\":\"Testing\",\"desc\":\"Testing\"}}}"}],"_postman_id":"9a6e0bf7-8a3a-43a4-924f-d738d4f54618"},{"name":"Update Project Categories","id":"a1165f77-9dc8-4940-94d3-700ac5ca76b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-categories\",\n \"attributes\": {\n \"name\": \"Testing patch\",\n \"desc\": \"Testing patch\"\n }\n }\n}"},"url":"{{endpoint}}/project-categories/{{project_category_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_category_id`	Required The assigned ID for the project category, this can be found by performing a GET {{endpoint}}/projects-categories request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"project-categories\"
`name`	Required Name of the project category. *Must be unique
`desc`	Optional Description of the project category.

","urlObject":{"path":["project-categories","{{project_category_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"c6cd2281-6145-4512-9727-5c03c1811d4e","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-categories\",\n \"attributes\": {\n \"name\": \"Testing patch\",\n \"desc\": \"Testing patch\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-categories/{{project_category_id}}","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"project-categories\",\"id\":\"1\",\"attributes\":{\"name\":\"Testing patch\",\"desc\":\"Testing patch\"}}}"}],"_postman_id":"a1165f77-9dc8-4940-94d3-700ac5ca76b8"},{"name":"Delete Project Categories","id":"aa4649ac-90ee-457c-abd3-9f2609fbe310","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/project-categories/{{project_category_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_category_id`	Required The assigned ID for the project category, this can be found by performing a GET {{endpoint}}/projects-categories request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"project-categories\"
`name`	Required Name of the project category. *Must be unique
`desc`	Optional Description of the project category.

","urlObject":{"path":["project-categories","{{project_category_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"debad36a-514f-4b11-9c6e-476d761741b5","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/project-categories/{{project_category_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"aa4649ac-90ee-457c-abd3-9f2609fbe310"}],"id":"65af6402-f4b8-4ed0-9c79-f366da2a04b1","description":"

Project category is a method for organizing projects.

\n","event":[{"listen":"prerequest","script":{"id":"e9e46f54-d5b2-44a4-8877-2f21f685cd36","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"57dfe288-a24c-4f5c-a742-c88754573d3b","type":"text/javascript","exec":[""]}}],"_postman_id":"65af6402-f4b8-4ed0-9c79-f366da2a04b1"},{"name":"Project Roles","item":[{"name":"Retrieve All Project Roles","id":"3a75c8ce-3683-4fe0-89f2-0f85afc5f085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/project-roles","urlObject":{"path":["project-roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9b0610e8-851b-464d-8c02-a305a351882f","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/project-roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"project-roles\",\"id\":\"1\",\"attributes\":{\"name\":\"Project Administrator\",\"desc\":\"\"}},{\"type\":\"project-roles\",\"id\":\"2\",\"attributes\":{\"name\":\"Contributor\",\"desc\":\"\"}},{\"type\":\"project-roles\",\"id\":\"3\",\"attributes\":{\"name\":\"User\",\"desc\":\"\"}},{\"type\":\"project-roles\",\"id\":\"65\",\"attributes\":{\"name\":\"Initiator\",\"desc\":\"\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/project-roles?page=1\"}},\"meta\":{\"totalCount\":4,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"3a75c8ce-3683-4fe0-89f2-0f85afc5f085"},{"name":"Retrieve Users in Project Role","id":"0dcc0cd8-19b6-42b0-b7f7-fbfa6ebcb52f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/project-roles/{{project_role_id}}/users","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_role_id`	Required The assigned ID for the project role, this can be found by performing a GET {{endpoint}}/projects-roles request.

","urlObject":{"path":["project-roles","{{project_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"50b0d213-7fd0-4496-a907-ba114572d356","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/project-roles/{{project_role_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"users\",\"id\":\"1\",\"attributes\":{\"username\":\"yhuang\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":\"2018-04-16T20:41:16+0000\",\"password_change_date\":\"2018-03-20T22:33:32+0000\",\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/1\"},\"relationships\":{\"person\":{\"data\":{\"id\":1,\"type\":\"people\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/project-roles/13/users?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"0dcc0cd8-19b6-42b0-b7f7-fbfa6ebcb52f"},{"name":"Create Project Roles","id":"0689932c-f149-42be-8ce5-3336da049927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-roles\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Project Category 2\",\n \"desc\": \"Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/project-roles","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'project-roles'
`name`	Required Name of the project role. *Must be unique
`desc`	Optional Description of the new project role.

","urlObject":{"path":["project-roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"0f92ce78-4d46-43db-a0d2-06de73b56188","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-roles\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Project Category 2\",\n \"desc\": \"Postman Description\",\n \"type\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-roles"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"project-roles\",\"id\":\"6\",\"attributes\":{\"name\":\"ACE 1401 Postman Project Category 2\",\"desc\":\"Postman Description\"},\"links\":{\"self\":\"/backend/v1/project-roles/view?id=6\"}}}"}],"_postman_id":"0689932c-f149-42be-8ce5-3336da049927"},{"name":"Add Users to Project Roles","id":"e710826b-2380-47fe-8d6f-5799d80af223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/project-roles/{{project_role_id}}/users","description":"

Add user(s) to a project role if none of the user(s) were already assigned to the project role. Replaces existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_role_id`	Required The assigned ID for the project role, this can be found by performing a GET {{endpoint}}/projects-roles request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the users, this can be found by performing a GET {{endpoint}}/users request.
`type`	Required \"users\"

","urlObject":{"path":["project-roles","{{project_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"7adf2d2c-1af3-4809-b8a5-297948930473","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-roles/{{project_role_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"users\",\"id\":\"1\",\"attributes\":{\"username\":\"yhuang\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":\"2018-04-16T20:41:16+0000\",\"password_change_date\":\"2018-03-20T22:33:32+0000\",\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/1\"},\"relationships\":{\"person\":{\"data\":{\"id\":1,\"type\":\"people\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/project-roles/13/users?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"e710826b-2380-47fe-8d6f-5799d80af223"},{"name":"Update Project Roles","id":"8b2de4d3-0019-4ee8-85fa-fc4b57be3ef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-roles\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Project Category 2\",\n \"desc\": \"Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/project-roles/{{project_role_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_role_id`	Required The assigned ID for the project role, this can be found by performing a GET {{endpoint}}/projects-roles request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'project-roles'
`name`	Required Name of the project role. *Must be unique
`desc`	Optional Description of the new project role.

","urlObject":{"path":["project-roles","{{project_role_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"84c1bd89-09a2-453d-a258-180ebcb4f3b7","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"project-roles\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Project Category EDIT\",\n \"desc\": \"Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-roles/{{project_role_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"project-roles\",\"id\":\"4\",\"attributes\":{\"name\":\"ACE 1401 Postman Project Category EDIT\",\"desc\":\"Postman Description EDIT\"},\"links\":{\"self\":\"/backend/v1/project-roles/view?id=4\"}}}"}],"_postman_id":"8b2de4d3-0019-4ee8-85fa-fc4b57be3ef9"},{"name":"Update Users in Project Role","id":"71ba8e91-bbd7-42df-a89d-a0e652c8bc02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/project-roles/{{project_role_id}}/users","description":"

Adds user(s) to the project role if none of the selected user(s) are already assigned to the project role. Appends to existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_role_id`	Required The assigned ID for the project role, this can be found by performing a GET {{endpoint}}/projects-roles request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the users, this can be found by performing a GET {{endpoint}}/users request.
`type`	Required \"users\"

","urlObject":{"path":["project-roles","{{project_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"6f0e1b5b-b128-4ad7-b981-082a84100083","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-roles/{{project_role_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"users\",\"id\":\"1\",\"attributes\":{\"username\":\"yhuang\",\"failed_attempts\":0,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":1,\"latest_login_date\":\"2018-04-16T20:41:16+0000\",\"password_change_date\":\"2018-03-20T22:33:32+0000\",\"federationid\":null},\"links\":{\"self\":\"/backend/v1/users/1\"},\"relationships\":{\"person\":{\"data\":{\"id\":1,\"type\":\"people\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/project-roles/13/users?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"71ba8e91-bbd7-42df-a89d-a0e652c8bc02"},{"name":"Delete Project Roles","id":"af493959-a858-4061-965c-1e9e64797ced","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/project-roles/{{project_role_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_role_id`	Required The assigned ID for the project role, this can be found by performing a GET {{endpoint}}/projects-roles request.

","urlObject":{"path":["project-roles","{{project_role_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"af493959-a858-4061-965c-1e9e64797ced"},{"name":"Remove Users in Project Role","id":"20fa4acb-ea74-4992-9c71-e785bad9e5aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/project-roles/{{project_role_id}}/users","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`project_role_id`	Required The assigned ID for the project role, this can be found by performing a GET {{endpoint}}/projects-roles request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the users, this can be found by performing a GET {{endpoint}}/users request.
`type`	Required \"users\"

","urlObject":{"path":["project-roles","{{project_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1855ed62-b263-470a-a27f-cd3c22d27408","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/project-roles/{{project_role_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":true}"}],"_postman_id":"20fa4acb-ea74-4992-9c71-e785bad9e5aa"}],"id":"79ef1197-ebb9-496f-9692-2421547eda19","description":"

Project roles represent groups of people with different permission levels for a project.

\n","event":[{"listen":"prerequest","script":{"id":"5e457c98-a57a-4aef-922d-1b596dc0d89e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"75d89f58-b4de-4b58-9dec-08e9e0f68972","type":"text/javascript","exec":[""]}}],"_postman_id":"79ef1197-ebb9-496f-9692-2421547eda19"},{"name":"Records","item":[{"name":"Retrieve All Records","id":"96f028da-f505-4530-a0a4-3f1b5ef9aa5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records","description":"

Returns a list of all records.

\n","urlObject":{"path":["records"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"96f028da-f505-4530-a0a4-3f1b5ef9aa5d"},{"name":"Retrieve Record Activity","id":"599080ed-ff6c-4ee8-ae6b-60552795d08c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/activities","description":"

Returns a list of all activities for a given record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","activities"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9c26ae13-1cb3-471d-9d0a-687925188830","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/activities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"6334f20abb0d87cba747eba42fa97b6a2b5bbc909a39425ae0b1aea323cc1262a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22m6G5wfOXj6D5DijSqkaVPguFJmfsQc3f%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"sys-logs\",\"id\":\"139\",\"attributes\":{\"module\":\"workflow\",\"model\":\"Record\",\"action\":\"new\",\"controller\":\"execution\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:22:59+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=139\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"140\",\"attributes\":{\"module\":\"learning\",\"model\":\"Page\",\"action\":\"create\",\"controller\":\"page\",\"model_id\":1,\"dateAdded\":\"2018-03-20T22:28:49+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=140\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"141\",\"attributes\":{\"module\":\"learning\",\"model\":\"Page\",\"action\":\"create\",\"controller\":\"page\",\"model_id\":2,\"dateAdded\":\"2018-03-20T22:28:55+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=141\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"157\",\"attributes\":{\"module\":\"workflow\",\"model\":\"Record\",\"action\":\"activate\",\"controller\":\"execution\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:32:03+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=157\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"158\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseParticipant\",\"action\":\"userTab\",\"controller\":\"participantWidget\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:32:09+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=158\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"159\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseParticipant\",\"action\":\"userTab\",\"controller\":\"participantWidget\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:32:14+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=159\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"160\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":1,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=160\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"161\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":2,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=161\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"162\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=162\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"163\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":4,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=163\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"164\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":5,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=164\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"165\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":6,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=165\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"166\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":7,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=166\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"167\",\"attributes\":{\"module\":\"learning\",\"model\":\"CourseSetting\",\"action\":\"courseSettings\",\"controller\":\"record\",\"model_id\":8,\"dateAdded\":\"2018-03-20T22:32:22+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=167\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"168\",\"attributes\":{\"module\":\"workflow\",\"model\":\"Record\",\"action\":\"activate\",\"controller\":\"execution\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:32:25+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=168\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}},{\"type\":\"sys-logs\",\"id\":\"169\",\"attributes\":{\"module\":\"workflow\",\"model\":\"Record\",\"action\":\"activate\",\"controller\":\"execution\",\"model_id\":3,\"dateAdded\":\"2018-03-20T22:32:29+00:00\"},\"links\":{\"self\":\"/backend/v1/sys-logs/view?id=169\"},\"relationships\":{\"trigger\":{\"data\":{\"id\":-1,\"type\":\"users\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/records/3/activities?page=1\"}},\"meta\":{\"totalCount\":16,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"599080ed-ff6c-4ee8-ae6b-60552795d08c"},{"name":"Retrieve Record Activity Details","id":"e5deaca8-2b48-4470-8da9-f9fe021beebe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/activities/{{activity_id}}","description":"

Returns the details of a specific action that occurred on a record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.
`activity_id`	Required The assigned ID for the activity, this can be found by performing a GET {{endpoint}}/records/{record_id}/activites request.

","urlObject":{"path":["records","{{record_id}}","activities","{{activity_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"53c7e934-21d6-4dc9-a814-6711a6a2bc5e","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/activities/{{activity_id}}","description":"List record activities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"sys-log-fields\",\"id\":\"23005\",\"attributes\":{\"field\":\"status\",\"old_value\":\"13\",\"old_text\":\"Closed - Effective (13)\",\"new_value\":\"13\",\"new_text\":\"Closed - Effective (13)\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/records/102/activities/7970?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"e5deaca8-2b48-4470-8da9-f9fe021beebe"},{"name":"Retrieve Record Attachments","id":"74596354-20af-4869-8dc2-3270a67aab6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/attachments","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","attachments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"6a8f2a36-a713-491e-9182-22893e1f5503","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/attachments","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"attachments\",\n \"id\": \"f4e1dc5b-b191-4677-8e67-5c3fab7b2d05\",\n \"attributes\": {\n \"date_created\": \"2017-11-09T22:59:30+0000\",\n \"name\": \"Example Attachment.docx\",\n \"size\": 271426,\n \"user\": 261\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/records/129/attachments?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"74596354-20af-4869-8dc2-3270a67aab6b"},{"name":"Retrieve Record Comments","id":"a78f603a-7941-4c2a-9e57-5748d7ca5055","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/comments","description":"

Returns a list of comments for a given record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","comments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d2786a87-81f5-4788-9f36-3ac8350de8a4","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/comments","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"comments\",\n \"id\": \"4\",\n \"attributes\": {\n \"message\": \"Testing comment\",\n \"created_date\": \"2017-04-18T12:09:05+0000\",\n \"updated_date\": \"2017-04-18T12:09:05+0000\"\n },\n \"relationships\": {\n \"owner\": {\n \"data\": {\n \"id\": 63,\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"type\": \"comments\",\n \"id\": \"5\",\n \"attributes\": {\n \"message\": \"Testing reply\",\n \"created_date\": \"2017-04-18T17:58:22+0000\",\n \"updated_date\": \"2017-04-18T17:58:22+0000\"\n },\n \"relationships\": {\n \"parentComment\": {\n \"data\": {\n \"id\": 4,\n \"type\": \"comments\"\n }\n },\n \"owner\": {\n \"data\": {\n \"id\": 6,\n \"type\": \"users\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/records/4/comments?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"a78f603a-7941-4c2a-9e57-5748d7ca5055"},{"name":"Retrieve Record Workflow","id":"558be467-1838-4797-bab7-ca4abcf5aa7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/workflow","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","workflow"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bfa97cb3-64e2-4866-aefb-38e45f99f0bb","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/paths","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"workflows\",\"id\":\"1\",\"attributes\":{\"name\":\"MRF\",\"description\":\"\"},\"links\":{\"self\":\"/backend/v1/workflows/1\"},\"relationships\":{\"histories\":{\"data\":{\"id\":[1],\"type\":\"workflow-histories\"}}}}}"}],"_postman_id":"558be467-1838-4797-bab7-ca4abcf5aa7f"},{"name":"Retrieve Record Transition History","id":"1155e240-53eb-4715-9124-8518102ea56f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/paths","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","paths"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1eb602ca-039a-47ec-a08f-263535bd07f1","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/paths","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-transitions\",\n \"id\": \"819\",\n \"attributes\": {\n \"name\": \"Revise Document\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflow-transitions/819\"\n },\n \"relationships\": {\n \"sourceStep\": {\n \"data\": {\n \"id\": 475,\n \"type\": \"workflow-steps\"\n }\n },\n \"destinationStep\": {\n \"data\": {\n \"id\": 476,\n \"type\": \"workflow-steps\"\n }\n },\n \"view\": {\n \"data\": {\n \"id\": 12,\n \"type\": \"forms\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/records/102/paths?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 5,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"1155e240-53eb-4715-9124-8518102ea56f"},{"name":"Retrieve Record Metadata","id":"21dc6137-b281-4c15-849c-da146662ac25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/meta","description":"

Returns the values of all system fields and custom fields for a given record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","meta"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"61a5325c-d151-42bc-853f-85eadcabb8a3","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/meta","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"records\",\n \"id\": \"100\",\n \"attributes\": {\n \"description\": null,\n \"title\": \"Example Document\",\n \"module\": \"Document\",\n \"date_created\": \"2017-10-04T00:00:00+0000\",\n \"date_updated\": \"2017-10-06T20:09:26+0000\",\n \"pkey\": \"SOP-00073\",\n \"rendition_type\": \"PDF\",\n \"cf_document_department\": \"Department\",\n \"author\": 189,\n \"cf_departmental_approver\": 227,\n \"cf_quality_assurance_ap\": 170,\n \"cf_legacy_document_numb\": \"A1225\",\n \"effective_date\": \"2017-09-29T00:00:00+0000\",\n \"cf_annual_update_deadli\": \"2020-09-29T00:00:00+0000\"\n },\n \"meta\": {\n \"rendition_type\": {\n \"type\": \"custom-fields\",\n \"id\": \"-39\",\n \"attributes\": {\n \"fieldType\": \"radioButtonList\",\n \"label\": \"Rendition Type\"\n }\n },\n \"cf_document_department\": {\n \"type\": \"custom-fields\",\n \"id\": \"27\",\n \"attributes\": {\n \"fieldType\": \"select\",\n \"label\": \"Document Owning Department\"\n }\n },\n \"author\": {\n \"type\": \"custom-fields\",\n \"id\": \"-7\",\n \"attributes\": {\n \"fieldType\": \"picker\",\n \"label\": \"Author\"\n }\n },\n \"cf_departmental_approver\": {\n \"type\": \"custom-fields\",\n \"id\": \"33\",\n \"attributes\": {\n \"fieldType\": \"picker\",\n \"label\": \"Departmental Approver\"\n }\n },\n \"cf_quality_assurance_ap\": {\n \"type\": \"custom-fields\",\n \"id\": \"30\",\n \"attributes\": {\n \"fieldType\": \"picker\",\n \"label\": \"Quality Assurance Approver\"\n }\n },\n \"cf_legacy_document_numb\": {\n \"type\": \"custom-fields\",\n \"id\": \"42\",\n \"attributes\": {\n \"fieldType\": \"textfield\",\n \"label\": \"Legacy Document Number\"\n }\n },\n \"effective_date\": {\n \"type\": \"custom-fields\",\n \"id\": \"-19\",\n \"attributes\": {\n \"fieldType\": \"datepicker\",\n \"label\": \"Effective Date\"\n }\n },\n \"cf_annual_update_deadli\": {\n \"type\": \"custom-fields\",\n \"id\": \"29\",\n \"attributes\": {\n \"fieldType\": \"datepicker\",\n \"label\": \"Periodic Review Deadline\"\n }\n }\n },\n \"links\": {\n \"self\": \"/backend/v1/records/100\"\n },\n \"relationships\": {\n \"initiator\": {\n \"data\": {\n \"id\": -1,\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"projects\"\n }\n },\n \"type\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"record-types\"\n }\n },\n \"status\": {\n \"data\": {\n \"id\": 475,\n \"type\": \"workflow-steps\"\n }\n }\n }\n }\n}"}],"_postman_id":"21dc6137-b281-4c15-849c-da146662ac25"},{"name":"Retrieve a Document","id":"85a78945-1dcd-4aa2-849d-c27db6ca1753","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/document/{{version}}","description":"

Retrieve a specific version of a document.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.
`version`	Required The assigned version for the document (i.e. 0.1, 1.0, effective, etc.).

","urlObject":{"path":["records","{{record_id}}","document","{{version}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e98da37c-0684-4d2b-abd6-41975fb621f3","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/document/{{version}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"version\": \"2.0\",\n \"effective_date\": \"2019-10-31T21:14:53+00:00\",\n \"url\": \"download_url\"\n }\n }\n}"}],"_postman_id":"85a78945-1dcd-4aa2-849d-c27db6ca1753"},{"name":"Retrieve a Document (PDF Rendition)","id":"69adfb13-5363-4c44-a679-9e8843d71c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/document/{{version}}/rendition","description":"

Retrieve a specific version of a document.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.
`version`	Required The assigned version for the document (i.e. 0.1, 1.0, effective, etc.).

","urlObject":{"path":["records","{{record_id}}","document","{{version}}","rendition"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1f2d4280-3932-4540-af24-bec84efe7d43","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/document/{{version}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"document\",\n \"attributes\": {\n \"version\": \"2.0\",\n \"effective_date\": \"2019-10-31T21:14:53+00:00\",\n \"url\": \"download_url\"\n }\n }\n}"}],"_postman_id":"69adfb13-5363-4c44-a679-9e8843d71c9e"},{"name":"Perform a Document Check-Out","id":"49a846e4-8f0d-431c-a475-dc720578119c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/checkOut","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","checkOut"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49a846e4-8f0d-431c-a475-dc720578119c"},{"name":"Initiate a Document Check-In","id":"c90fcd86-6150-406d-81a8-db8dc4bf9ecc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"records\",\n \"attributes\": {\n \"filename\": \"sample.docx\"\n }\n }\n}"},"url":"{{endpoint}}/records/{{record_id}}/checkIn","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","checkIn"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"1c087d77-44c7-473a-9d06-a9a39cb7dd8c","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"records\",\n \"attributes\": {\n \"filename\": \"sample.pdf\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/records/{{record_id}}/checkIn"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"source\": {\n \"formData\": {\n \"acl\": \"private\",\n \"key\": \"source_key\",\n \"X-Amz-Credential\": \"source_credential\",\n \"X-Amz-Algorithm\": \"source_algorithm\",\n \"X-Amz-Date\": \"source_date\",\n \"Policy\": \"source_policy\",\n \"X-Amz-Signature\": \"source_signature\"\n },\n \"formAttributes\": {\n \"action\": \"source_action\",\n \"method\": \"POST\",\n \"enctype\": \"multipart/form-data\"\n },\n \"id\": \"source id\"\n },\n \"rendition\": {\n \"formData\": {\n \"acl\": \"private\",\n \"key\": \"rendition_key\",\n \"X-Amz-Credential\": \"rendition_credential\",\n \"X-Amz-Algorithm\": \"rendition_algorithm\",\n \"X-Amz-Date\": \"rendition_date\",\n \"Policy\": \"rendition_policy\",\n \"X-Amz-Signature\": \"rendition_signature\"\n },\n \"formAttributes\": {\n \"action\": \"rendition_action\",\n \"method\": \"POST\",\n \"enctype\": \"multipart/form-data\"\n },\n \"id\": \"rendition_id\"\n }\n }\n}"}],"_postman_id":"c90fcd86-6150-406d-81a8-db8dc4bf9ecc"},{"name":"Search Records","id":"58380a00-e267-41e3-8d01-3c78b321520f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, pkey, title from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/records/search","description":"

Returns a list of records.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["records","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"a2fa88fc-470b-4b5e-bf8d-3518053f4c2e","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/search","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"records\",\n \"id\": \"1\",\n \"attributes\": {\n \"description\": null,\n \"title\": null,\n \"module\": \"Workflow\",\n \"date_created\": \"2017-03-23T13:56:42+0000\",\n \"date_updated\": \"2017-03-23T14:54:11+0000\",\n \"pkey\": \"MRF-1\"\n },\n \"links\": {\n \"self\": \"/backend/v1/records/1\"\n },\n \"relationships\": {\n \"initiator\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"projects\"\n }\n },\n \"type\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"record-types\"\n }\n },\n \"status\": {\n \"data\": {\n \"id\": 9,\n \"type\": \"workflow-steps\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/records/search?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/records/search?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/records/search?page=103\"\n }\n },\n \"meta\": {\n \"totalCount\": 2047,\n \"pageCount\": 103,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"58380a00-e267-41e3-8d01-3c78b321520f"},{"name":"Create Records","id":"bc75e407-2e16-44ba-8a12-ffc04d46241b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"records\",\n \"attributes\": {\n \"title\": \"API Record Test 15\",\n \"description\": \"API Record Test 15\",\n \"project_id\": 10,\n \"parent_id\": 26,\n \"type\": 11,\n \"status_id\": 2,\n \"cf_ace_1401_dropdown_2\": \"B\",\n \"cf_ace_1401_radio_butto\": \"C\",\n \"cf_ace_1401_dat_picker\": \"2018-08-15T13:30:00+07:00\",\n \"cf_ace_1401_group_picker_group_none\": [\n 6,\n 7,\n 8\n ],\n \"cf_ace_1401_multiselect\": [\n \"AAAA\",\n \"BBBB\"\n ],\n \"cf_ace_1401_grid\": [\n [\n {\n \"key\": \"Textbox15acbc77074642\",\n \"value\": \"AAA\"\n },\n {\n \"key\": \"Textbox NEW5acbd2266286f\",\n \"value\": \"BBB\"\n },\n {\n \"key\": \"Checkbox15b7d8bea4d254\",\n \"value\": 1\n }\n ]\n ]\n }\n }\n}"},"url":"{{endpoint}}/records","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"records\"
`title`	Required Title of the record. *Must be unique
`description`	Optional Description of the record.
`project_id`	Required `project_id` The assigned ID for the project associated with the record, this can be found by performing a GET {{endpoint}}/projects request.
`Custom Fields`	Custom fields on the form associated the the create transition of the record should be specifed here.

","urlObject":{"path":["records"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"33bec9e7-51cd-4e47-8c7c-6b225526db69","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"records\",\n \"attributes\": {\n \"title\": \"API Record Test 14\",\n \"description\": \"API Record Test 14\",\n \"project_id\": 10,\n \"parent_id\": 26,\n \"type\": 11,\n \"status_id\": 2,\n \"cf_ace_1401_dropdown_2\": \"B\",\n \"cf_ace_1401_radio_butto\": \"B\",\n \"cf_ace_1401_dat_picker\": \"1/8/18 00:00\",\n \"cf_ace_1401_group_picker_group_none\": [\n 1,\n 2,\n 3\n ],\n \"cf_ace_1401_multiselect\": [\n \"AAAA\",\n \"BBBB\"\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/records"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"29e3a63dcf29c8081459bab6b353b5faf20ac0b9d5dd511bf5f0f36fbb33f4d5a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22PNXfD5A27VPGVk7-dVaFTxn0rc6VYHD4%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":{\"type\":\"records\",\"id\":\"45\",\"attributes\":{\"description\":\"API Record Test 14\",\"title\":\"API Record Test 14\",\"module\":\"Document\",\"date_created\":\"2018-08-21T21:43:35+00:00\",\"date_updated\":\"2018-08-21T21:43:35+00:00\",\"pkey\":\" BIDDER - 002\",\"cf_ace_1401_dropdown_2\":\"B\",\"cf_ace_1401_radio_butto\":\"B\"},\"meta\":{\"cf_ace_1401_dropdown_2\":{\"type\":\"custom-fields\",\"id\":\"70\",\"attributes\":{\"fieldType\":\"select\",\"label\":\"ACE 1401 Dropdown 2\"}},\"cf_ace_1401_radio_butto\":{\"type\":\"custom-fields\",\"id\":\"71\",\"attributes\":{\"fieldType\":\"radioButtonList\",\"label\":\"ACE 1401 Radio Buttons\"}}},\"links\":{\"self\":\"/backend/v1/records/45\"},\"relationships\":{\"initiator\":{\"data\":{\"id\":1,\"type\":\"users\"}},\"parent\":{\"data\":{\"id\":26,\"type\":\"records\"}},\"project\":{\"data\":{\"id\":10,\"type\":\"projects\"}},\"type\":{\"data\":{\"id\":11,\"type\":\"record-types\"}},\"status\":{\"data\":{\"id\":2,\"type\":\"workflow-steps\"}}}}}"}],"_postman_id":"bc75e407-2e16-44ba-8a12-ffc04d46241b"},{"name":"Add Attachments to Record","id":"6ac9c6a3-3e81-4627-994f-789a13ec9ddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"attachments\",\n \"attributes\": {\n \"filename\": \"\"\n }\n }\n ]\n}"},"url":"{{endpoint}}/records/{{record_id}}/attachments","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"records\"
`filename`	The name of the attachment.

","urlObject":{"path":["records","{{record_id}}","attachments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ac9c6a3-3e81-4627-994f-789a13ec9ddd"},{"name":"Add Comments to Record","id":"f50b878d-60c7-4a5f-bd53-c876d6a186e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"comments\",\n \"attributes\": {\n \"message\": \"testing comment\"\n }\n }\n}"},"url":"{{endpoint}}/records/{{record_id}}/comments","description":"

Add comments to a record if none of the comments were already assigned to the record. Replaces existing comments if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'comments'
`message`	Required New comment.

","urlObject":{"path":["records","{{record_id}}","comments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"7e52e814-edb0-4d95-884b-d8c7f759cb39","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"comments\",\n \"attributes\": {\n \"message\": \"testing comment\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/records/{{record_id}}/comments","description":"Require Add Comment Permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"comments\",\"id\":\"41\",\"attributes\":{\"message\":\"testing comment\",\"created_date\":\"2018-02-01T01:12:33+0000\",\"updated_date\":\"2018-02-01T01:12:33+0000\"},\"relationships\":{\"parentComment\":{\"data\":{\"id\":36,\"type\":\"comments\"}},\"owner\":{\"data\":{\"id\":1,\"type\":\"users\"}}}}]}"}],"_postman_id":"f50b878d-60c7-4a5f-bd53-c876d6a186e9"},{"name":"Update Records","id":"ae53d537-8bd8-4376-bc5a-cd3dd95a7bb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"id\": \"2136\",\n \"type\": \"test-step-execution-records\",\n \"record_variable\": 1,\n \"execution_signature\": {\n \"user_id\":18,\n \"decision\":1,\n \"reason\":\"vvvvv\"\n },\n \"execution_assignee_signature\": {\n \"user_id\":18,\n \"decision\":1,\n \"reason\":\"vvvvv\"\n },\n \"attributes\": {\n \"title\": \"Hello World 4\",\n \"description\": \"update me 6\",\n \"project_id\": 3,\n \"type\": 14,\n \"status_id\": 2,\n \"require_retrain\": \"Yes\",\n \"effective\": \"No\",\n \"cf_current_visit\": \"1A\",\n \"cf_trainers\": [\n 100,\n 1\n ],\n \"cf_date_of_review_reque\": \"2018-05-01T00:00+07:00\",\n \"cf_date_of_trainin\": \"2018-05-01T00:00:00+07:00\",\n \"rendition_type\": \"PDF\",\n \"cf_a_test_grid\": [\n [\n {\n \"key\": \"Part ID5aa7e73a7df2c\",\n \"value\": \"98205\"\n },\n {\n \"key\": \"Supplier Catalog Machined\"\n },\n {\n \"value\": \"N/A\"\n },\n {\n \"key\": \"Supplier Lot #5aa7e73a7e015\",\n \"value\": \"N/A\"\n },\n {\n \"key\": \"Equipment #5aa7e73a7e04e\",\n \"value\": \"N/A\"\n },\n {\n \"key\": \"Quantity5aa7e73a7e088\",\n \"value\": \"1\"\n },\n {\n \"key\": \"Cost5aa7e73a7e0c2\",\n \"value\": \"22\"\n }\n ]\n ]\n }\n }\n}"},"url":"{{endpoint}}/test-step-execution-records/{{record_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["test-step-execution-records","{{record_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"8fbca15c-3872-455c-a5b0-61afb4f95d73","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}","description":"List record activities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"records\",\"id\":\"1\",\"attributes\":{\"title\":\"Updated Title\"}}}"}],"_postman_id":"ae53d537-8bd8-4376-bc5a-cd3dd95a7bb1"},{"name":"Update Attachments to Record","id":"b11a5ba7-dded-4902-8f8a-2f3d199c66d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"attachments\",\n \"id\": \"1534870441-2d070ffd-2b03-3118-869d-bec9f65b4dc2\",\n \"attributes\": {}\n }\n ]\n}"},"url":"{{endpoint}}/records/{{record_id}}/attachments","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"records\"
`id`	Required `attachments_id` The assigned ID for the attachment, this can be found by performing a GET {{endpoint}}/records/{record_id}/attachments request.

","urlObject":{"path":["records","{{record_id}}","attachments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b11a5ba7-dded-4902-8f8a-2f3d199c66d7"},{"name":"Update Comments to Record","id":"fef66422-21b6-4ca6-a7b2-d7021a5638c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"comments\",\n \"id\": \"42\",\n \"attributes\": {\n \"message\": \"testing comment update 5\"\n }\n }\n}"},"url":"{{endpoint}}/records/{{record_id}}/comments","description":"

Adds comments to the record. Appends to existing comments if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Requiured 'comments'
`id`	Required `comments_id` The assigned ID for the comment, this can be found by performing a GET {{endpoint}}/records/{record_id}/comments request.
`message`	Required Details of the updated comments.

","urlObject":{"path":["records","{{record_id}}","comments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e39c9c70-e186-4013-8423-995c7ba5a596","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"comments\",\n \"attributes\": {\n \"message\": \"testing comment\",\n \"parent_id\": 36\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/records/{{record_id}}/comments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"comments\",\"id\":\"41\",\"attributes\":{\"message\":\"testing comment\",\"created_date\":\"2018-02-01T01:12:33+0000\",\"updated_date\":\"2018-02-01T01:12:33+0000\"},\"relationships\":{\"parentComment\":{\"data\":{\"id\":36,\"type\":\"comments\"}},\"owner\":{\"data\":{\"id\":1,\"type\":\"users\"}}}}]}"}],"_postman_id":"fef66422-21b6-4ca6-a7b2-d7021a5638c2"},{"name":"Perform a Document Check-In","id":"6e2463c6-35eb-4830-9c61-1cd57967a214","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"source\": \"source_id\",\n \"rendition\": \"rendition_id\"\n }\n}"},"url":"{{endpoint}}/records/{{record_id}}/checkIn","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","checkIn"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e2463c6-35eb-4830-9c61-1cd57967a214"},{"name":"Cancel a Document Check-Out","id":"a0d79e00-ba78-484c-b3e0-40241f791bf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/checkOut","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the record, this can be found by performing a GET {{endpoint}}/records request.

","urlObject":{"path":["records","{{record_id}}","checkOut"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0d79e00-ba78-484c-b3e0-40241f791bf2"}],"id":"2532bb67-acda-4e31-80ce-b4746a52bcf5","description":"

A record is a data object created for workflow types (document, report, audit, etc.) and will carry out the process of a workflow.

\n","event":[{"listen":"prerequest","script":{"id":"e9aac914-a6da-4ea2-a790-ec396f911fea","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"303cdeca-077e-4799-8f05-31200a27e501","type":"text/javascript","exec":[""]}}],"_postman_id":"2532bb67-acda-4e31-80ce-b4746a52bcf5"},{"name":"Record States","item":[{"name":"Retrieve All Record States","id":"392baee6-19bf-424d-951e-bd33194de507","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/record-states","urlObject":{"path":["record-states"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9038593d-469e-48b4-a164-9f2e117bace9","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/record-states","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"record-states\",\n \"id\": \"-1\",\n \"attributes\": {\n \"name\": \"Start\",\n \"desc\": null,\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Opened\",\n \"desc\": null,\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"Cancelled\",\n \"desc\": \"\",\n \"color\": \"#19c8e0\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"3\",\n \"attributes\": {\n \"name\": \"Response Determination\",\n \"desc\": \"\",\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"4\",\n \"attributes\": {\n \"name\": \"CSM Determination\",\n \"desc\": \"\",\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"5\",\n \"attributes\": {\n \"name\": \"CSM Confirm Response\",\n \"desc\": \"\",\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"6\",\n \"attributes\": {\n \"name\": \"Confirm Medical Response\",\n \"desc\": \"\",\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"7\",\n \"attributes\": {\n \"name\": \"Confirm No Medical Response\",\n \"desc\": \"\",\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"8\",\n \"attributes\": {\n \"name\": \"Closed - Done\",\n \"desc\": \"\",\n \"color\": \"#0cc72a\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"9\",\n \"attributes\": {\n \"name\": \"QA Final Approval\",\n \"desc\": \"\",\n \"color\": \"#bfc22d\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"10\",\n \"attributes\": {\n \"name\": \"Review in Process\",\n \"desc\": \"\",\n \"color\": \"#30e813\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"11\",\n \"attributes\": {\n \"name\": \"Final Approval\",\n \"desc\": \"\",\n \"color\": \"#12cc1a\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"12\",\n \"attributes\": {\n \"name\": \"Closed - Obsolete\",\n \"desc\": null,\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"13\",\n \"attributes\": {\n \"name\": \"Closed - Effective\",\n \"desc\": null,\n \"color\": \"#5d91c2\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"14\",\n \"attributes\": {\n \"name\": \"Set Attributes\",\n \"desc\": \"\",\n \"color\": \"#18de38\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"15\",\n \"attributes\": {\n \"name\": \"Periodic Review Assessment\",\n \"desc\": \"\",\n \"color\": \"#551ec9\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"16\",\n \"attributes\": {\n \"name\": \"Approve Obsolete Status\",\n \"desc\": \"\",\n \"color\": \"#e31d10\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"17\",\n \"attributes\": {\n \"name\": \"Administrative Change\",\n \"desc\": \"\",\n \"color\": \"#e06a28\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"18\",\n \"attributes\": {\n \"name\": \"Periodic Review Complete\",\n \"desc\": \"\",\n \"color\": \"#7c3de3\",\n \"sequence\": null\n }\n },\n {\n \"type\": \"record-states\",\n \"id\": \"19\",\n \"attributes\": {\n \"name\": \"Doc Control Review\",\n \"desc\": \"\",\n \"color\": \"#2fc916\",\n \"sequence\": null\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/record-states?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/record-states?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/record-states?page=3\"\n }\n },\n \"meta\": {\n \"totalCount\": 47,\n \"pageCount\": 3,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"392baee6-19bf-424d-951e-bd33194de507"},{"name":"Create Record States","id":"3cfeb6e3-ce11-4907-a79d-06234751dc78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-states\",\n \"attributes\": {\n \"name\": \"testing\",\n \"desc\": \"testing data\",\n \"color\": \"#dddddd\",\n \"sequence\": 1\n }\n }\n}"},"url":"{{endpoint}}/record-states","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'record-states'
`name`	Required Name of the new record state.
`desc`	Optional Description of the new record state.
`color`	Optional Color of the new record state.
`sequence`	Optional Sequence of the new record state.

","urlObject":{"path":["record-states"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3aa58142-eead-4d6a-9b96-ac7308afb3e0","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-states\",\n \"attributes\": {\n \"name\": \"testing\",\n \"desc\": \"testing data\",\n \"color\": \"#dddddd\",\n \"sequence\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/record-states","description":"Searching record"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"record-states\",\"id\":\"102\",\"attributes\":{\"name\":\"testing\",\"desc\":\"testing data\",\"color\":\"#dddddd\",\"sequence\":1}}}"}],"_postman_id":"3cfeb6e3-ce11-4907-a79d-06234751dc78"},{"name":"Update Record States","id":"b0979937-4251-4e9c-b270-6acee4dbf3fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-states\",\n \"attributes\": {\n \"name\": \"Update\",\n \"desc\": \"testing Update\",\n \"color\": \"#000000\",\n \"sequence\": 2\n }\n }\n}"},"url":"{{endpoint}}/record-states/{{record_state_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_state_id`	Required The assigned ID for the record state, this can be found by performing a GET {{endpoint}}/record-states request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'record-states'
`name`	Required Name of updated record state.
`desc`	Optional Description of updated record state.
`color`	Optional Color of updated record state.
`sequence`	Optional Sequence of updated record state.

","urlObject":{"path":["record-states","{{record_state_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"20f8c197-169e-42bc-a17b-869057486070","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-states\",\n \"id\": \"102\",\n \"attributes\": {\n \"name\": \"Update\",\n \"desc\": \"testing Update\",\n \"color\": \"#000000\",\n \"sequence\": 2\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/record-states/{{record_state_id}}","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"record-states\",\"id\":\"102\",\"attributes\":{\"name\":\"Update\",\"desc\":\"testing Update\",\"color\":\"#000000\",\"sequence\":2}}}"}],"_postman_id":"b0979937-4251-4e9c-b270-6acee4dbf3fe"},{"name":"Delete Record States","id":"aa356b6a-c49a-4435-baf5-19817138ef51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/record-states/{{record_state_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_state_id`	Required The assigned ID for the record state, this can be found by performing a GET {{endpoint}}/record-states request.

","urlObject":{"path":["record-states","{{record_state_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"0a897d3c-b66c-43d6-a3c3-5a32412226a1","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/record-states/{{record_state_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"aa356b6a-c49a-4435-baf5-19817138ef51"}],"id":"9bd1f7fb-1401-4dac-aa5d-0d2087ad2d7a","description":"

Record states define the current status of a record in a workflow as it transitions through its life cycle.

\n","event":[{"listen":"prerequest","script":{"id":"d4157957-a564-4031-a9eb-71b21b39ae26","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eeefeacf-0904-4a03-b63a-4166c82c7fad","type":"text/javascript","exec":[""]}}],"_postman_id":"9bd1f7fb-1401-4dac-aa5d-0d2087ad2d7a"},{"name":"Record Types","item":[{"name":"Retrieve All Record Types","id":"88d45c31-ee2e-4700-a78a-0a53e251b326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/record-types","urlObject":{"path":["record-types"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"4ac17b0f-bc32-40ae-8f86-f61e636201f0","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/record-types","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"record-types\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Medical Review Record\",\n \"desc\": \"\",\n \"rtcount\": 28,\n \"rtkey\": \"MRF\",\n \"autonumformat\": \"[PROJECT_KEY]-[PROJECT_COUNT]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/1\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"Standard Operating Procedure\",\n \"desc\": \"\",\n \"rtcount\": 218,\n \"rtkey\": \"SOP\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/2\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"3\",\n \"attributes\": {\n \"name\": \"Company Policy\",\n \"desc\": \"\",\n \"rtcount\": 15,\n \"rtkey\": \"POL\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/3\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"4\",\n \"attributes\": {\n \"name\": \"Specification\",\n \"desc\": \"\",\n \"rtcount\": 251,\n \"rtkey\": \"SPEC\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/4\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"5\",\n \"attributes\": {\n \"name\": \"Protocol\",\n \"desc\": \"\",\n \"rtcount\": 34,\n \"rtkey\": \"PRO\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/5\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"6\",\n \"attributes\": {\n \"name\": \"FORM\",\n \"desc\": \"\",\n \"rtcount\": 108,\n \"rtkey\": \"FORM\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/6\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"7\",\n \"attributes\": {\n \"name\": \"Master Batch Record\",\n \"desc\": \"\",\n \"rtcount\": 33,\n \"rtkey\": \"MBR\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/7\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"8\",\n \"attributes\": {\n \"name\": \"Risk Assessment\",\n \"desc\": \"\",\n \"rtcount\": 1,\n \"rtkey\": \"RA\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/8\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"9\",\n \"attributes\": {\n \"name\": \"Reports\",\n \"desc\": \"\",\n \"rtcount\": 12,\n \"rtkey\": \"RPT\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/9\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"10\",\n \"attributes\": {\n \"name\": \"Template\",\n \"desc\": \"\",\n \"rtcount\": 1,\n \"rtkey\": \"TEMP\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/10\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"11\",\n \"attributes\": {\n \"name\": \"Development Validation Protocol (DVP)\",\n \"desc\": \"\",\n \"rtcount\": 1053,\n \"rtkey\": \"DVP\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/11\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"12\",\n \"attributes\": {\n \"name\": \"Development Validation Report (DVR)\",\n \"desc\": \"\",\n \"rtcount\": 1070,\n \"rtkey\": \"DVR\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/12\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"13\",\n \"attributes\": {\n \"name\": \"Commercial/Clinical Labeling\",\n \"desc\": \"\",\n \"rtcount\": 16,\n \"rtkey\": \"LABEL\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/13\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"14\",\n \"attributes\": {\n \"name\": \"Guidelines\",\n \"desc\": \"\",\n \"rtcount\": 29,\n \"rtkey\": \"GDL\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/14\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"15\",\n \"attributes\": {\n \"name\": \"Test Methods\",\n \"desc\": \"\",\n \"rtcount\": 254,\n \"rtkey\": \"QCT\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/15\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"16\",\n \"attributes\": {\n \"name\": \"Work Instructions\",\n \"desc\": \"\",\n \"rtcount\": 23,\n \"rtkey\": \"WI\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/16\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"17\",\n \"attributes\": {\n \"name\": \"PLAN\",\n \"desc\": \"\",\n \"rtcount\": 20,\n \"rtkey\": \"PLN\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/17\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"23\",\n \"attributes\": {\n \"name\": \"Temperature Excursion Record\",\n \"desc\": \"\",\n \"rtcount\": 1,\n \"rtkey\": \"TER\",\n \"autonumformat\": \"[PROJECT_KEY]-[PROJECT_COUNT]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/23\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"24\",\n \"attributes\": {\n \"name\": \"Courses\",\n \"desc\": \"\",\n \"rtcount\": 7,\n \"rtkey\": \"COU\",\n \"autonumformat\": \"[PROJECT_KEY]-[PROJECT_COUNT]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/24\"\n }\n },\n {\n \"type\": \"record-types\",\n \"id\": \"25\",\n \"attributes\": {\n \"name\": \"Trainer Led Training\",\n \"desc\": \"This course type will be used for one time training classes led by a company trainer.\",\n \"rtcount\": 0,\n \"rtkey\": \"TLT\",\n \"autonumformat\": \"[PROJECT_KEY]-[PROJECT_COUNT]\"\n },\n \"links\": {\n \"self\": \"/backend/v1/record-types/25\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/record-types?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/record-types?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/record-types?page=2\"\n }\n },\n \"meta\": {\n \"totalCount\": 21,\n \"pageCount\": 2,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"88d45c31-ee2e-4700-a78a-0a53e251b326"},{"name":"Search Record Types","id":"c12a20f3-2ad5-4a7f-a3ee-2b66d496b390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, name, desc from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/record-types/search","description":"

Returns a list of record types.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["record-types","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"fa458b56-4621-407a-bb3a-fbfec340015e","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/projects/search","description":"Search custom fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"record-types\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Medical Review Form\",\n \"desc\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/record-types/search?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 6,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"c12a20f3-2ad5-4a7f-a3ee-2b66d496b390"},{"name":"Create Record Types","id":"ce4b9ad2-f4cf-42ec-a665-7f8d73fc7ef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-types\",\n \"attributes\": {\n \"name\": \"Testing record type\",\n \"desc\": \"Description\",\n \"rtcount\": 100,\n \"rtkey\": \"TESTING\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n }\n }\n}"},"url":"{{endpoint}}/record-types","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'record-types'
`name`	Required Name of the record type.
`desc`	Optional Description of the record type.
`rtcount`	Optional A unique number assigned for the record type.
`rtkey`	Required A unique, abbreviated key which can be configured for use in record identification.
`autonumformat`	Optional The numbering format when configuring automatic numbering. Please see your ACE manual for formatting syntax.

","urlObject":{"path":["record-types"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"c6967d7d-d0b3-4ab3-9154-6e5dfffcf9a5","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-types\",\n \"attributes\": {\n \"name\": \"Testing record type\",\n \"desc\": \"Description\",\n \"rtcount\": 100,\n \"rtkey\": \"TESTING\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/record-types","description":"Searching record"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"record-types\",\"id\":\"28\",\"attributes\":{\"name\":\"Testing record type\",\"desc\":\"Description\",\"rtcount\":100,\"rtkey\":\"TESTING\",\"autonumformat\":\"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:5]\"},\"links\":{\"self\":\"/backend/v1/record-types/28\"}}}"}],"_postman_id":"ce4b9ad2-f4cf-42ec-a665-7f8d73fc7ef1"},{"name":"Update Record Types","id":"b8d36d32-e126-48bc-aa20-6a1d872ac1f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-types\",\n \"id\": \"28\",\n \"attributes\": {\n \"name\": \"Testing record type 2\",\n \"desc\": \"Description 2\",\n \"rtcount\": 106,\n \"rtkey\": \"TESTING2\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:6]\"\n }\n }\n}"},"url":"{{endpoint}}/record-types/{{record_type_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_type_id`	Required The assigned ID for the record type, this can be found by performing a GET {{endpoint}}/record-types request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'record-types'
`name`	Required Name of the record type.
`desc`	Optional Description of the record type.
`rtcount`	Optional A unique number assigned for the record type.
`rtkey`	Required A unique, abbreviated key which can be configured for use in record identification.
`autonumformat`	Optional The numbering format when configuring automatic numbering. Please see your ACE manual for formatting syntax.

","urlObject":{"path":["record-types","{{record_type_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"ae994cee-c22a-48fd-a9ff-f33164cd1881","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"record-types\",\n \"id\": \"28\",\n \"attributes\": {\n \"name\": \"Testing record type 2\",\n \"desc\": \"Description 2\",\n \"rtcount\": 106,\n \"rtkey\": \"TESTING2\",\n \"autonumformat\": \"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:6]\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/record-types/{{record_type_id}}","description":"Searching record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"record-types\",\"id\":\"28\",\"attributes\":{\"name\":\"Testing record type 2\",\"desc\":\"Description 2\",\"rtcount\":106,\"rtkey\":\"TESTING2\",\"autonumformat\":\"[RECORD_TYPE_KEY]-[RECORD_TYPE_COUNT:6]\"},\"links\":{\"self\":\"/backend/v1/record-types/28\"}}}"}],"_postman_id":"b8d36d32-e126-48bc-aa20-6a1d872ac1f7"},{"name":"Delete Record Types","id":"b6bbbdd0-9087-414b-9c68-938121e8c2e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/record-types/{{record_type_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_type_id`	Required The assigned ID for the record type, this can be found by performing a GET {{endpoint}}/record-types request.

","urlObject":{"path":["record-types","{{record_type_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d727605a-1e0e-412d-9583-4105c179bac8","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/record-types/{{record_type_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b6bbbdd0-9087-414b-9c68-938121e8c2e0"}],"id":"37ffce0c-06e0-40c3-bfa6-9d218683c0bb","description":"

Record types define the automatic numbering for a record and link records to workflows, checklists, scribes, and documents. Records can be used for different purposes and therefore require different record types.

\n","event":[{"listen":"prerequest","script":{"id":"aa14ace8-4734-497d-959a-2b34da136a69","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3a2c1ef6-8ea0-460b-b80c-792a7308a15b","type":"text/javascript","exec":[""]}}],"_postman_id":"37ffce0c-06e0-40c3-bfa6-9d218683c0bb"},{"name":"Reports","item":[{"name":"Retrieve All Report Types","id":"76e11c6f-f217-473d-8f9d-eaccbc8994d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/report-types","description":"

Returns the actual data of all of the items for a given type of report. The reportTypes you can use are as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record`	Data of fields that define a record.
`execution-history`	Data of fields that define the execution history of a workflow.
`learning-history`	Data of fields that define the learning history of a user.
`document-info`	Data of fields that define the document information.

","urlObject":{"path":["reports","report-types"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e9ca16a7-7930-4634-82b1-6f47cd3cab92","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/report-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"81e83a26e70060a26318f41c02d17a213aeacbacba23d8c2fe55e8a98a38b86fa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%220Y2ryhMxAWQquhie2jyEsQ3-iw8tQYyJ%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"report-add-ins\",\"id\":\"record\"},{\"type\":\"report-add-ins\",\"id\":\"execution-history\"},{\"type\":\"report-add-ins\",\"id\":\"learning-history\"},{\"type\":\"report-add-ins\",\"id\":\"document-info\"}],\"links\":{\"self\":{\"href\":\"/backend/v1/reports/report-types?page=1\"}},\"meta\":{\"totalCount\":4,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"76e11c6f-f217-473d-8f9d-eaccbc8994d9"},{"name":"Retrieve All Fields in Report Type","id":"40670a7d-64b1-4ecf-af39-0b126b60893a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/meta/{{reportType}}","description":"

Returns the metadata of all the fields used for each type of report. To view the report types you can use for this request, please use the GET request for /reports/data/report-types.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`reportType`	Required The assigned ID for the report type, this can be found by performing a GET `{{endpoint}}/record/report-types` request.

","urlObject":{"path":["reports","meta","{{reportType}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"719aa555-8682-4780-b181-bd9af9709021","name":"Successful Response (Execution History)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/meta/execution-history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"7f6ac515bb134110f2837867127548cf1f3ecc98e51c34f217998385201bba54a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22xvwq82bjWvWaybLu6W9yG3aWmxRpWGFb%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"record-fields\",\"id\":\"id\",\"attributes\":{\"name\":\"id\",\"label\":\"ID\",\"fieldType\":\"picker\",\"datatype\":\"record\",\"alias\":\"pkey\"}},{\"type\":\"record-fields\",\"id\":\"parent_id\",\"attributes\":{\"name\":\"parent_id\",\"label\":\"Parent Record\",\"fieldType\":\"picker\",\"datatype\":\"record\"}},{\"type\":\"record-fields\",\"id\":\"project_id\",\"attributes\":{\"name\":\"project_id\",\"label\":\"Project\",\"fieldType\":\"picker\",\"datatype\":\"project\"}},{\"type\":\"record-fields\",\"id\":\"initiator_id\",\"attributes\":{\"name\":\"initiator_id\",\"label\":\"Initiator\",\"fieldType\":\"picker\",\"datatype\":\"user\"}},{\"type\":\"record-fields\",\"id\":\"type\",\"attributes\":{\"name\":\"type\",\"label\":\"Record Type\",\"fieldType\":\"picker\",\"datatype\":\"recordtype\"}},{\"type\":\"record-fields\",\"id\":\"description\",\"attributes\":{\"name\":\"description\",\"label\":\"Description\",\"fieldType\":\"text\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"title\",\"attributes\":{\"name\":\"title\",\"label\":\"Title\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_created\",\"attributes\":{\"name\":\"date_created\",\"label\":\"Date Created\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_updated\",\"attributes\":{\"name\":\"date_updated\",\"label\":\"Date Updated\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"status_id\",\"attributes\":{\"name\":\"status.linked_state\",\"includes\":\"status\",\"label\":\"Status\",\"fieldType\":\"picker\",\"datatype\":\"recordstate\"}},{\"type\":\"record-fields\",\"id\":\"workflow_source_step_id\",\"attributes\":{\"name\":\"workflow_source_step_id\",\"label\":\"Source Step\",\"fieldType\":\"picker\",\"datatype\":\"recordstate\"}},{\"type\":\"record-fields\",\"id\":\"workflow_destination_step_id\",\"attributes\":{\"name\":\"workflow_destination_step_id\",\"label\":\"Destination Step\",\"fieldType\":\"picker\",\"datatype\":\"recordstate\"}},{\"type\":\"record-fields\",\"id\":\"workflow_execution_time\",\"attributes\":{\"name\":\"workflow_execution_time\",\"label\":\"Execution Time\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"duration\",\"attributes\":{\"name\":\"duration\",\"label\":\"Duration\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"activator_id\",\"attributes\":{\"name\":\"activator_id\",\"label\":\"Activator\",\"fieldType\":\"picker\",\"datatype\":\"user\"}}]}"},{"id":"a6c8fb92-3022-403f-a0bd-aab371fbb4c5","name":"Successful Response (Learning History)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/meta/learning-history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"ae8c95f70104ad820e4a009ff5e75a2c05db1f3de1e253f10a589d720db158daa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22L1zp_2Klu9LLRa4XUAVOig7a0acI_jek%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"record-fields\",\"id\":\"id\",\"attributes\":{\"name\":\"id\",\"label\":\"ID\",\"fieldType\":\"picker\",\"datatype\":\"record\",\"alias\":\"pkey\"}},{\"type\":\"record-fields\",\"id\":\"parent_id\",\"attributes\":{\"name\":\"parent_id\",\"label\":\"Parent Record\",\"fieldType\":\"picker\",\"datatype\":\"record\"}},{\"type\":\"record-fields\",\"id\":\"project_id\",\"attributes\":{\"name\":\"project_id\",\"label\":\"Project\",\"fieldType\":\"picker\",\"datatype\":\"project\"}},{\"type\":\"record-fields\",\"id\":\"initiator_id\",\"attributes\":{\"name\":\"initiator_id\",\"label\":\"Initiator\",\"fieldType\":\"picker\",\"datatype\":\"user\"}},{\"type\":\"record-fields\",\"id\":\"type\",\"attributes\":{\"name\":\"type\",\"label\":\"Record Type\",\"fieldType\":\"picker\",\"datatype\":\"recordtype\"}},{\"type\":\"record-fields\",\"id\":\"description\",\"attributes\":{\"name\":\"description\",\"label\":\"Description\",\"fieldType\":\"text\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"title\",\"attributes\":{\"name\":\"title\",\"label\":\"Title\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_created\",\"attributes\":{\"name\":\"date_created\",\"label\":\"Date Created\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_updated\",\"attributes\":{\"name\":\"date_updated\",\"label\":\"Date Updated\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"status_id\",\"attributes\":{\"name\":\"status.linked_state\",\"includes\":\"status\",\"label\":\"Status\",\"fieldType\":\"picker\",\"datatype\":\"recordstate\"}},{\"type\":\"record-fields\",\"id\":\"tg_user\",\"attributes\":{\"name\":\"tg_user\",\"label\":\"Trained User\",\"fieldType\":\"picker\",\"datatype\":\"user\"}},{\"type\":\"record-fields\",\"id\":\"tbr_status\",\"attributes\":{\"name\":\"tbr_status\",\"label\":\"Document Status\",\"fieldType\":\"select\",\"useKey\":true,\"data\":{\"values\":[{\"key\":100,\"data\":\"Approved\"},{\"key\":200,\"data\":\"Effective\"},{\"key\":300,\"data\":\"Retired\"}]}}},{\"type\":\"record-fields\",\"id\":\"tbr_type\",\"attributes\":{\"name\":\"tbr_type\",\"label\":\"To-be-read Document\",\"fieldType\":\"select\",\"useKey\":true,\"data\":{\"values\":[{\"key\":-100,\"data\":\"No\"},{\"key\":100,\"data\":\"Yes\"}]}}},{\"type\":\"record-fields\",\"id\":\"tbr_version\",\"attributes\":{\"name\":\"tbr_version\",\"label\":\"Document Version\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"tg_version\",\"attributes\":{\"name\":\"tg_version\",\"label\":\"Course Version\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"tg_status\",\"attributes\":{\"name\":\"tg_status\",\"label\":\"Training Status\",\"fieldType\":\"select\",\"datatype\":null,\"useKey\":true,\"data\":{\"values\":[{\"key\":0,\"data\":\"Incomplete - Not Started\"},{\"key\":1,\"data\":\"Complete - Not Passed\"},{\"key\":2,\"data\":\"Complete - Passed\"},{\"key\":3,\"data\":\"Pending - Under Review\"},{\"key\":4,\"data\":\"In Progress\"},{\"key\":5,\"data\":\"Retraining Required\"},{\"key\":6,\"data\":\"Complete - Obsolete\"},{\"key\":7,\"data\":\"Retrained In Progress\"},{\"key\":8,\"data\":\"Incomplete - Participant Signature Required\"}]}}},{\"type\":\"record-fields\",\"id\":\"tg_course_status\",\"attributes\":{\"name\":\"tg_course_status\",\"label\":\"Course Status\",\"fieldType\":\"select\",\"datatype\":null,\"useKey\":true,\"data\":{\"values\":[{\"key\":0,\"data\":\"Ineffective\"},{\"key\":1,\"data\":\"Effective\"},{\"key\":2,\"data\":\"Obsolete\"}]}}},{\"type\":\"record-fields\",\"id\":\"tbr_training_role_id\",\"attributes\":{\"name\":\"tbr_training_role_id\",\"label\":\"Training Role\",\"fieldType\":\"picker\",\"datatype\":\"trainingRole\"}},{\"type\":\"record-fields\",\"id\":\"tg_date_expire\",\"attributes\":{\"name\":\"tg_date_expire\",\"label\":\"Expiration Date\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"tg_date_completed\",\"attributes\":{\"name\":\"tg_date_completed\",\"label\":\"Trained Date\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"tbr_effective_date\",\"attributes\":{\"name\":\"tbr_effective_date\",\"label\":\"Effective date\",\"fieldType\":\"datetimepicker\",\"datatype\":null}}]}"},{"id":"a83ef247-d345-4746-9102-146061bc11b0","name":"Successful Response (Record)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/meta/record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"74bb84e7ba7b5dc9a663fe81d7104920e13b7597bd5b4c19504926b68bf18ddfa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22i_hz7Js9lt4fYnJNfpVkwDqKItsCMisi%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"record-fields\",\"id\":\"id\",\"attributes\":{\"name\":\"id\",\"label\":\"ID\",\"fieldType\":\"picker\",\"datatype\":\"record\",\"alias\":\"pkey\"}},{\"type\":\"record-fields\",\"id\":\"parent_id\",\"attributes\":{\"name\":\"parent_id\",\"label\":\"Parent Record\",\"fieldType\":\"picker\",\"datatype\":\"record\"}},{\"type\":\"record-fields\",\"id\":\"project_id\",\"attributes\":{\"name\":\"project_id\",\"label\":\"Project\",\"fieldType\":\"picker\",\"datatype\":\"project\"}},{\"type\":\"record-fields\",\"id\":\"initiator_id\",\"attributes\":{\"name\":\"initiator_id\",\"label\":\"Initiator\",\"fieldType\":\"picker\",\"datatype\":\"user\"}},{\"type\":\"record-fields\",\"id\":\"type\",\"attributes\":{\"name\":\"type\",\"label\":\"Record Type\",\"fieldType\":\"picker\",\"datatype\":\"recordtype\"}},{\"type\":\"record-fields\",\"id\":\"description\",\"attributes\":{\"name\":\"description\",\"label\":\"Description\",\"fieldType\":\"text\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"title\",\"attributes\":{\"name\":\"title\",\"label\":\"Title\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_created\",\"attributes\":{\"name\":\"date_created\",\"label\":\"Date Created\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_updated\",\"attributes\":{\"name\":\"date_updated\",\"label\":\"Date Updated\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"status_id\",\"attributes\":{\"name\":\"status.linked_state\",\"includes\":\"status\",\"label\":\"Status\",\"fieldType\":\"picker\",\"datatype\":\"recordstate\"}}]}"},{"id":"bcc14313-8d85-4082-b02f-f1d9ade0efa2","name":"Successful Response (Document Info)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/meta/document-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"4650575ec8dc94f69fc58a128e36a230a11571eb46511c71f8f2358251333316a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22CvCbL66MPruRjIlP7E1MHKZNYRpFzonO%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"record-fields\",\"id\":\"id\",\"attributes\":{\"name\":\"id\",\"label\":\"ID\",\"fieldType\":\"picker\",\"datatype\":\"record\",\"alias\":\"pkey\"}},{\"type\":\"record-fields\",\"id\":\"parent_id\",\"attributes\":{\"name\":\"parent_id\",\"label\":\"Parent Record\",\"fieldType\":\"picker\",\"datatype\":\"record\"}},{\"type\":\"record-fields\",\"id\":\"project_id\",\"attributes\":{\"name\":\"project_id\",\"label\":\"Project\",\"fieldType\":\"picker\",\"datatype\":\"project\"}},{\"type\":\"record-fields\",\"id\":\"initiator_id\",\"attributes\":{\"name\":\"initiator_id\",\"label\":\"Initiator\",\"fieldType\":\"picker\",\"datatype\":\"user\"}},{\"type\":\"record-fields\",\"id\":\"type\",\"attributes\":{\"name\":\"type\",\"label\":\"Record Type\",\"fieldType\":\"picker\",\"datatype\":\"recordtype\"}},{\"type\":\"record-fields\",\"id\":\"description\",\"attributes\":{\"name\":\"description\",\"label\":\"Description\",\"fieldType\":\"text\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"title\",\"attributes\":{\"name\":\"title\",\"label\":\"Title\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_created\",\"attributes\":{\"name\":\"date_created\",\"label\":\"Date Created\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"date_updated\",\"attributes\":{\"name\":\"date_updated\",\"label\":\"Date Updated\",\"fieldType\":\"datetimepicker\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"status_id\",\"attributes\":{\"name\":\"status.linked_state\",\"includes\":\"status\",\"label\":\"Status\",\"fieldType\":\"picker\",\"datatype\":\"recordstate\"}},{\"type\":\"record-fields\",\"id\":\"tbr_version\",\"attributes\":{\"name\":\"tbr_version\",\"label\":\"Document Version\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"tbr_status\",\"attributes\":{\"name\":\"tbr_status\",\"label\":\"Document Status\",\"fieldType\":\"select\",\"useKey\":true,\"data\":{\"values\":[{\"key\":100,\"data\":\"Approved\"},{\"key\":200,\"data\":\"Effective\"},{\"key\":300,\"data\":\"Retired\"}]}}},{\"type\":\"record-fields\",\"id\":\"tg_version\",\"attributes\":{\"name\":\"tg_version\",\"label\":\"Course Version\",\"fieldType\":\"textfield\",\"datatype\":null}},{\"type\":\"record-fields\",\"id\":\"tg_course_status\",\"attributes\":{\"name\":\"tg_course_status\",\"label\":\"Course Status\",\"fieldType\":\"select\",\"datatype\":null,\"useKey\":true,\"data\":{\"values\":[{\"key\":0,\"data\":\"Ineffective\"},{\"key\":1,\"data\":\"Effective\"},{\"key\":2,\"data\":\"Obsolete\"}]}}},{\"type\":\"record-fields\",\"id\":\"tbr_effective_date\",\"attributes\":{\"name\":\"tbr_effective_date\",\"label\":\"Effective date\",\"fieldType\":\"datetimepicker\",\"datatype\":null}}]}"}],"_postman_id":"40670a7d-64b1-4ecf-af39-0b126b60893a"},{"name":"Retrieve Report Type Data","id":"c3d49bc3-b500-439b-9b17-e4642f05c2dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/data/{{reportType}}","description":"

Returns the actual data of all of the items for a given type of report. To view the report types you can use for this request, please use the GET request for /reports/data/report-types.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`reportType`	Required The assigned ID for the report type, this can be found by performing a GET `{{endpoint}}/record/report-types` request.

","urlObject":{"path":["reports","data","{{reportType}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3928ff73-3a4f-4b83-9952-6ce3a020207b","name":"Successful Response (Execution History)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/data/execution-history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"e85c94a0ad7ab1b3df8cd6abc4bba709fd3f59dde56425f85b08488c37eaa6c9a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22fU1tC_bAbnrnZQ1s4fOD-3yQlvqgwJjk%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"generic\",\"id\":\"5b5659b252a3e\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-03-20T21:58:54+00:00\",\"duration\":0,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b252b86\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":2,\"workflow_execution_time\":\"2018-03-20T22:34:00+00:00\",\"duration\":2106,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b252cc7\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"workflow_source_step_id\":2,\"workflow_destination_step_id\":3,\"workflow_execution_time\":\"2018-04-11T14:37:14+00:00\",\"duration\":1872194,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b252deb\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-03-20T22:18:52+00:00\",\"duration\":0,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b252f0d\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":3,\"workflow_execution_time\":\"2018-03-20T22:34:24+00:00\",\"duration\":932,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b253030\",\"attributes\":{\"description\":\"TEST\",\"title\":\"ACE 1950 CD TBR THREE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:30:24+00:00\",\"date_updated\":\"2018-05-23T17:44:38+00:00\",\"pkey\":\"AIEZ-3-CD\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-03-20T22:30:25+00:00\",\"duration\":0,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b253162\",\"attributes\":{\"description\":\"Testing on this because I'm too lazy to create a new project\",\"title\":\"ACE 1401 Test\",\"module\":\"Document\",\"date_created\":\"2018-05-22T22:50:44+00:00\",\"date_updated\":\"2018-05-22T22:51:33+00:00\",\"pkey\":\"AIEZ-4-CD\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-05-22T22:50:44+00:00\",\"duration\":0,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b25328f\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-03-20T22:22:59+00:00\",\"duration\":0,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b2533c3\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":3,\"workflow_execution_time\":\"2018-03-20T22:32:03+00:00\",\"duration\":544,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b25351c\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":3,\"workflow_execution_time\":\"2018-03-20T22:32:29+00:00\",\"duration\":4,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b253651\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"workflow_source_step_id\":3,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-03-20T22:32:25+00:00\",\"duration\":22,\"activator_id\":-1}},{\"type\":\"generic\",\"id\":\"5b5659b253791\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:41:39+00:00\",\"date_updated\":\"2018-06-01T15:48:15+00:00\",\"pkey\":\"ADZA-1-ADZA\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-04-16T18:41:39+00:00\",\"duration\":0,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b2538b7\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:41:39+00:00\",\"date_updated\":\"2018-06-01T15:48:15+00:00\",\"pkey\":\"ADZA-1-ADZA\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-06-01T15:30:19+00:00\",\"duration\":3962920,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b2539dc\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:41:39+00:00\",\"date_updated\":\"2018-06-01T15:48:15+00:00\",\"pkey\":\"ADZA-1-ADZA\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-06-01T15:30:57+00:00\",\"duration\":38,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b253afe\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:41:39+00:00\",\"date_updated\":\"2018-06-01T15:48:15+00:00\",\"pkey\":\"ADZA-1-ADZA\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-06-01T15:31:09+00:00\",\"duration\":12,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b253c22\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:42:10+00:00\",\"date_updated\":\"2018-04-16T18:42:10+00:00\",\"pkey\":\"ADZA-2-ADZA\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-04-16T18:42:10+00:00\",\"duration\":0,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b253d47\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-05-22T22:46:38+00:00\",\"date_updated\":\"2018-05-24T21:06:59+00:00\",\"pkey\":\"ADZA-3-ADZA\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-05-22T22:46:38+00:00\",\"duration\":0,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b253e75\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-05-22T22:46:38+00:00\",\"date_updated\":\"2018-05-24T21:06:59+00:00\",\"pkey\":\"ADZA-3-ADZA\",\"workflow_source_step_id\":1,\"workflow_destination_step_id\":3,\"workflow_execution_time\":\"2018-05-22T22:48:25+00:00\",\"duration\":107,\"activator_id\":1}},{\"type\":\"generic\",\"id\":\"5b5659b254020\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-06-01T15:53:59+00:00\",\"date_updated\":\"2018-06-01T16:02:18+00:00\",\"pkey\":\"ADZA-4-ADZA\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-06-01T15:53:59+00:00\",\"duration\":0,\"activator_id\":2}},{\"type\":\"generic\",\"id\":\"5b5659b25418f\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Report\",\"date_created\":\"2018-05-25T17:52:28+00:00\",\"date_updated\":\"2018-05-25T17:52:28+00:00\",\"pkey\":\"AIEZCHILD-1-RPT\",\"workflow_source_step_id\":-1,\"workflow_destination_step_id\":1,\"workflow_execution_time\":\"2018-05-25T17:52:28+00:00\",\"duration\":0,\"activator_id\":1}}],\"links\":{\"self\":{\"href\":\"/backend/v1/reports/data/execution-history?page=1\"},\"next\":{\"href\":\"/backend/v1/reports/data/execution-history?page=2\"},\"last\":{\"href\":\"/backend/v1/reports/data/execution-history?page=3\"}},\"meta\":{\"totalCount\":42,\"pageCount\":3,\"currentPage\":1,\"perPage\":20}}"},{"id":"59933943-3cc5-4640-b1aa-b94e92b9ee22","name":"Successful Response (Learning History)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/data/learning-history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"830d0745ee418e2211c680ae599e0d557442ba8a2928d1357081e6b2f823c6f9a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%229IooET8Crmz1lXRs3b5IthaiykesPdc5%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"generic\",\"id\":\"5b56598463a39\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tg_user\":1,\"tbr_status\":200,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":5,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":\"2018-05-31T14:35:36+00:00\",\"tbr_effective_date\":\"2018-03-20T22:34:27+00:00\"}},{\"type\":\"generic\",\"id\":\"5b56598463be0\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tg_user\":2,\"tbr_status\":200,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":\"2018-03-20T22:34:27+00:00\"}},{\"type\":\"generic\",\"id\":\"5b56598463d6e\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tg_user\":23,\"tbr_status\":200,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":\"2018-03-20T22:34:27+00:00\"}},{\"type\":\"generic\",\"id\":\"5b56598463ef7\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tg_user\":3,\"tbr_status\":200,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":\"2018-03-20T22:34:27+00:00\"}},{\"type\":\"generic\",\"id\":\"5b565984640a2\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tg_user\":1,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598464222\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tg_user\":2,\"tbr_status\":0,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":2,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":\"1970-01-01T00:00:00+00:00\"}},{\"type\":\"generic\",\"id\":\"5b5659846440f\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tg_user\":3,\"tbr_status\":0,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":2,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":\"1970-01-01T00:00:00+00:00\"}},{\"type\":\"generic\",\"id\":\"5b565984646f1\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tg_user\":1,\"tbr_status\":0,\"tbr_type\":100,\"tbr_version\":\"1.0\",\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":2,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":\"1970-01-01T00:00:00+00:00\"}},{\"type\":\"generic\",\"id\":\"5b565984648c5\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tg_user\":2,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598464a6b\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tg_user\":3,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598464c02\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tg_user\":1,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598464d97\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":1,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":2,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598464f27\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":2,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":2,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b565984650bf\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":3,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"1.0\",\"tg_status\":0,\"tg_course_status\":2,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598465251\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":1,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b565984653e4\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":2,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659846556b\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":3,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"2.0\",\"tg_status\":0,\"tg_course_status\":1,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b565984656f5\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":1,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"3.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598465894\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":2,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"3.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b56598465a19\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tg_user\":3,\"tbr_status\":null,\"tbr_type\":0,\"tbr_version\":null,\"tg_version\":\"3.0\",\"tg_status\":0,\"tg_course_status\":0,\"tbr_training_role_id\":null,\"tg_date_expire\":null,\"tg_date_completed\":null,\"tbr_effective_date\":null}}],\"links\":{\"self\":{\"href\":\"/backend/v1/reports/data/learning-history?page=1\"},\"next\":{\"href\":\"/backend/v1/reports/data/learning-history?page=2\"},\"last\":{\"href\":\"/backend/v1/reports/data/learning-history?page=2\"}},\"meta\":{\"totalCount\":23,\"pageCount\":2,\"currentPage\":1,\"perPage\":20}}"},{"id":"bf36a33c-445b-4184-ae18-da5b4ac2348d","name":"Successful Response (Document Info)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/data/document-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"5ac35cd72320155ff061e49bf79a2c12df6432b520a228d905b9e5068e10601da%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%229gFoPgV0HrB6dK7uJ7k1zkkYeX7VWCIi%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"generic\",\"id\":\"5b5659ca83cda\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tbr_version\":\"1.0\",\"tbr_status\":0,\"tg_version\":\"1.0\",\"tg_course_status\":2,\"tbr_effective_date\":\"1970-01-01T00:00:00+00:00\"}},{\"type\":\"generic\",\"id\":\"5b5659ca83e2a\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"2.0\",\"tg_course_status\":0,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659ca83f6d\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tbr_version\":\"1.0\",\"tbr_status\":200,\"tg_version\":\"1.0\",\"tg_course_status\":1,\"tbr_effective_date\":\"2018-03-20T22:34:27+00:00\"}},{\"type\":\"generic\",\"id\":\"5b5659ca840ab\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"2.0\",\"tg_course_status\":0,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659ca841de\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"1.0\",\"tg_course_status\":2,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659ca8430f\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"2.0\",\"tg_course_status\":1,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659ca84463\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"3.0\",\"tg_course_status\":0,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659ca8458e\",\"attributes\":{\"description\":\"TEST\",\"title\":\"ACE 1950 CD TBR THREE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:30:24+00:00\",\"date_updated\":\"2018-05-23T17:44:38+00:00\",\"pkey\":\"AIEZ-3-CD\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"1.0\",\"tg_course_status\":0,\"tbr_effective_date\":null}},{\"type\":\"generic\",\"id\":\"5b5659ca846b9\",\"attributes\":{\"description\":\"Testing on this because I'm too lazy to create a new project\",\"title\":\"ACE 1401 Test\",\"module\":\"Document\",\"date_created\":\"2018-05-22T22:50:44+00:00\",\"date_updated\":\"2018-05-22T22:51:33+00:00\",\"pkey\":\"AIEZ-4-CD\",\"tbr_version\":null,\"tbr_status\":null,\"tg_version\":\"1.0\",\"tg_course_status\":0,\"tbr_effective_date\":null}}],\"links\":{\"self\":{\"href\":\"/backend/v1/reports/data/document-info?page=1\"}},\"meta\":{\"totalCount\":9,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"},{"id":"bf982e25-15ce-4244-942e-e0a39049cad7","name":"Successful Response (Record)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/reports/data/record"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"localhost","path":"/","secure":false,"value":"25514c220c2956cccbe569fe54500d6f266418260175f44ea7fde1809077d5aaa%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22b7B6d-5zW-nmGM918tznImKzI1REM4RC%22%3B%7D","key":"_csrf"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"generic\",\"id\":\"5b5659a107332\",\"attributes\":{\"description\":\"INTERMEDIATE TRAINING\",\"title\":\"ACE 1950 CD TBR ONE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T21:58:54+00:00\",\"date_updated\":\"2018-04-11T14:37:13+00:00\",\"pkey\":\"AIEZ-1-CD\"}},{\"type\":\"generic\",\"id\":\"5b5659a107433\",\"attributes\":{\"description\":\"EFFECTIVE TRAINING\",\"title\":\"ACE 1950 CD TBR TWO\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:18:52+00:00\",\"date_updated\":\"2018-03-20T22:34:24+00:00\",\"pkey\":\"AIEZ-2-CD\"}},{\"type\":\"generic\",\"id\":\"5b5659a107529\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Learning\",\"date_created\":\"2018-03-20T22:22:59+00:00\",\"date_updated\":\"2018-03-20T22:32:29+00:00\",\"pkey\":\"AIEZ-1-CRS\"}},{\"type\":\"generic\",\"id\":\"5b5659a10761c\",\"attributes\":{\"description\":\"TEST\",\"title\":\"ACE 1950 CD TBR THREE\",\"module\":\"Document\",\"date_created\":\"2018-03-20T22:30:24+00:00\",\"date_updated\":\"2018-05-23T17:44:38+00:00\",\"pkey\":\"AIEZ-3-CD\"}},{\"type\":\"generic\",\"id\":\"5b5659a10770d\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:41:39+00:00\",\"date_updated\":\"2018-06-01T15:48:15+00:00\",\"pkey\":\"ADZA-1-ADZA\"}},{\"type\":\"generic\",\"id\":\"5b5659a1077fd\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-04-16T18:42:10+00:00\",\"date_updated\":\"2018-04-16T18:42:10+00:00\",\"pkey\":\"ADZA-2-ADZA\"}},{\"type\":\"generic\",\"id\":\"5b5659a1078e9\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-05-22T22:46:38+00:00\",\"date_updated\":\"2018-05-24T21:06:59+00:00\",\"pkey\":\"ADZA-3-ADZA\"}},{\"type\":\"generic\",\"id\":\"5b5659a1079d6\",\"attributes\":{\"description\":\"Testing on this because I'm too lazy to create a new project\",\"title\":\"ACE 1401 Test\",\"module\":\"Document\",\"date_created\":\"2018-05-22T22:50:44+00:00\",\"date_updated\":\"2018-05-22T22:51:33+00:00\",\"pkey\":\"AIEZ-4-CD\"}},{\"type\":\"generic\",\"id\":\"5b5659a107ac3\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Report\",\"date_created\":\"2018-05-25T17:52:28+00:00\",\"date_updated\":\"2018-05-25T17:52:28+00:00\",\"pkey\":\"AIEZCHILD-1-RPT\"}},{\"type\":\"generic\",\"id\":\"5b5659a107bb3\",\"attributes\":{\"description\":null,\"title\":null,\"module\":\"Workflow\",\"date_created\":\"2018-06-01T15:53:59+00:00\",\"date_updated\":\"2018-06-01T16:02:18+00:00\",\"pkey\":\"ADZA-4-ADZA\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/reports/data/record?page=1\"}},\"meta\":{\"totalCount\":10,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"c3d49bc3-b500-439b-9b17-e4642f05c2dc"},{"name":"Retrieve Report Type Data (Editable)","id":"aeb37903-82a6-45d6-aef4-c5859c6e6ba7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"SELECT cf_ace_1401_role_picker_project_role from __main__ where pkey like \\\"ADZA-4-ADZA\\\" \"\n}"},"url":"{{endpoint}}/reports/data/{{reportType}}","description":"

Returns the actual data of items used for a given type of report. This report can be further modified by adding a filter. To view the report types you can use for this request, please use the GET request for /reports/data/report-types.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`reportType`	Required The assigned ID for the report type, this can be found by performing a GET `{{endpoint}}/record/report-types` request.

","urlObject":{"path":["reports","data","{{reportType}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aeb37903-82a6-45d6-aef4-c5859c6e6ba7"}],"id":"4ee3e892-a035-4ca4-8d03-a5161771f6ef","description":"

Reports are used to generate metadata or actual data for records, execution histories, learning histories, and document information. This provides a similar function to the Analytics Report section in ACE. The three default main report types that you can use for the request are as follows (NOTE: You can also generate the list of available report types by using the GET request for \"/reports/data/report-types\"):

Report Types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record`	Metadata or data of fields that define a record. This provides a similar report to an ACE Analytics Record Report.
`execution-history`	Metadata or data of fields that define the execution history of a workflow. This provides a similar report to an ACE Analytics Workflow Report.
`learning-history`	Metadata or data of fields that define the learning history of a user. This provides a similar report to an ACE Analytics Training Report.

","event":[{"listen":"prerequest","script":{"id":"20790f6f-b512-4870-8b9f-864c0bf90e0d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a717d5a6-e3a4-4422-8168-863321d178ee","type":"text/javascript","exec":[""]}}],"_postman_id":"4ee3e892-a035-4ca4-8d03-a5161771f6ef"},{"name":"Schemes","item":[{"name":"Retrieve All Workflow Schemes","id":"c0659e84-7b6b-4690-a9fe-fab6ec4ac97f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-schemes","urlObject":{"path":["workflow-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d81fabaf-a0ce-4622-b76a-b2c822be44bc","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-schemes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-schemes\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"MRF Scheme\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/scheme/view?type=workflow&id=1\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflow-schemes?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 5,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"c0659e84-7b6b-4690-a9fe-fab6ec4ac97f"},{"name":"Retrieve All Task Schemes","id":"f92c9987-e752-4a13-a13e-7cba327a23b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/task-schemes","urlObject":{"path":["task-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"239544a1-bb0a-4c35-9f2f-9ec12e8debce","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/task-schemes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"task-schemes\",\"id\":\"62e29f03-e297-446c-8c61-0c1a4ba49112\",\"attributes\":{\"name\":\"Controlled Document Tasks\",\"description\":\"\"},\"links\":{\"self\":\"/backend/v1/task-scheme/view?id=62e29f03-e297-446c-8c61-0c1a4ba49112\"}},{\"type\":\"task-schemes\",\"id\":\"996277ab-ad55-45ad-b1aa-4da74a8532c1\",\"attributes\":{\"name\":\"Managed Documents Tasks\",\"description\":\"\"},\"links\":{\"self\":\"/backend/v1/task-scheme/view?id=996277ab-ad55-45ad-b1aa-4da74a8532c1\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/task-schemes?page=1\"}},\"meta\":{\"totalCount\":2,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"f92c9987-e752-4a13-a13e-7cba327a23b1"},{"name":"Retrieve All Calendar Schemes","id":"dd7293ed-7857-41f4-9c80-6659f833383c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/calendar-schemes","urlObject":{"path":["calendar-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"7d5c7146-a54a-4f02-b5c7-3d51457703b5","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/calendar-schemes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"calendar-schemes\",\"id\":\"1\",\"attributes\":{\"name\":\"Controlled Document \",\"description\":\"\"}},{\"type\":\"calendar-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"UV Periodic Doc Review\",\"description\":\"\"}},{\"type\":\"calendar-schemes\",\"id\":\"4\",\"attributes\":{\"name\":\"Inspection Calendar Scheme\",\"description\":\"\"}},{\"type\":\"calendar-schemes\",\"id\":\"6\",\"attributes\":{\"name\":\"Khan\",\"description\":\"Test\"}},{\"type\":\"calendar-schemes\",\"id\":\"7\",\"attributes\":{\"name\":\"Test for Record Variable Inserts\",\"description\":\"\"}},{\"type\":\"calendar-schemes\",\"id\":\"8\",\"attributes\":{\"name\":\"calendar scheme 1191\",\"description\":\"description of calendar scheme\"}},{\"type\":\"calendar-schemes\",\"id\":\"9\",\"attributes\":{\"name\":\"calendar scheme 06/17/16\",\"description\":\"\"}},{\"type\":\"calendar-schemes\",\"id\":\"10\",\"attributes\":{\"name\":\"scheme 5\",\"description\":\"\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/calendar-schemes?page=1\"}},\"meta\":{\"totalCount\":8,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"dd7293ed-7857-41f4-9c80-6659f833383c"},{"name":"Retrieve All Notification Schemes","id":"41c4a1e6-8c06-4b9f-b2c3-f3e1803c7daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/notification-schemes","urlObject":{"path":["notification-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"fd8001cb-16df-43d6-952c-2c9c7fd6ca5b","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/notification-schemes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"notification-schemes\",\"id\":\"-26\",\"attributes\":{\"name\":\"Supplier Product Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-25\",\"attributes\":{\"name\":\"Inspection Criteria Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-24\",\"attributes\":{\"name\":\"Return Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-23\",\"attributes\":{\"name\":\"Supplier Record Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-22\",\"attributes\":{\"name\":\"SCAR Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-19\",\"attributes\":{\"name\":\"Risk Assessment Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-18\",\"attributes\":{\"name\":\"Change Control PM Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-17\",\"attributes\":{\"name\":\"Correction Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-16\",\"attributes\":{\"name\":\"Incoming Inspection Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-14\",\"attributes\":{\"name\":\"Out Of Spec Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-13\",\"attributes\":{\"name\":\"Effectiveness Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-12\",\"attributes\":{\"name\":\"CAPA Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-11\",\"attributes\":{\"name\":\"CAPA Action Item Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"-8\",\"attributes\":{\"name\":\"Complaint Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"1\",\"attributes\":{\"name\":\"Controlled Documents Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"Inspection Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"3\",\"attributes\":{\"name\":\"Request Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"4\",\"attributes\":{\"name\":\"Audit Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"5\",\"attributes\":{\"name\":\"UV Periodic Review Notification Scheme\",\"description\":\"\"}},{\"type\":\"notification-schemes\",\"id\":\"6\",\"attributes\":{\"name\":\"UV Work Request NScheme\",\"description\":\"\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/notification-schemes?page=1\"},\"next\":{\"href\":\"/backend/v1/notification-schemes?page=2\"},\"last\":{\"href\":\"/backend/v1/notification-schemes?page=2\"}},\"meta\":{\"totalCount\":29,\"pageCount\":2,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"41c4a1e6-8c06-4b9f-b2c3-f3e1803c7daa"},{"name":"Retrieve All Permission Schemes","id":"c268bbb8-5c9e-4ea4-83b9-979d2ea58b9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/permission-schemes","description":"

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
Authorization	Bearer < ACCESS TOKEN>
Content-Type	application/json

","urlObject":{"path":["permission-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"826a4091-0058-4904-8100-2f93834d3251","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/permission-schemes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"permission-schemes\",\"id\":\"-26\",\"attributes\":{\"name\":\"Supplier Product Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-25\",\"attributes\":{\"name\":\"Inspection Criteria Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-24\",\"attributes\":{\"name\":\"Return Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-23\",\"attributes\":{\"name\":\"Supplier Record Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-22\",\"attributes\":{\"name\":\"SCAR Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-21\",\"attributes\":{\"name\":\"Risk Assessment Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-20\",\"attributes\":{\"name\":\"Change Control PM Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-19\",\"attributes\":{\"name\":\"Correction Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-18\",\"attributes\":{\"name\":\"Incoming Inspection Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-17\",\"attributes\":{\"name\":\"NCR Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-16\",\"attributes\":{\"name\":\"Out of Spec Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-15\",\"attributes\":{\"name\":\"Complaint Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-14\",\"attributes\":{\"name\":\"Effectiveness Check Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-13\",\"attributes\":{\"name\":\"CAPA Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"-12\",\"attributes\":{\"name\":\"CAPA Action Item Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"1\",\"attributes\":{\"name\":\"Controlled Documents\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"Inspection Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"3\",\"attributes\":{\"name\":\"Request Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"4\",\"attributes\":{\"name\":\"Audit Permission Scheme\",\"desc\":\"\"}},{\"type\":\"permission-schemes\",\"id\":\"5\",\"attributes\":{\"name\":\"Audit Report\",\"desc\":\"\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/permission-schemes?page=1\"},\"next\":{\"href\":\"/backend/v1/permission-schemes?page=2\"},\"last\":{\"href\":\"/backend/v1/permission-schemes?page=3\"}},\"meta\":{\"totalCount\":57,\"pageCount\":3,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"c268bbb8-5c9e-4ea4-83b9-979d2ea58b9b"},{"name":"Retrieve Workflow Scheme Record Types","id":"95c3475e-2f2f-401a-8181-2545102e4ed4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-schemes/{{scheme_id}}/record-types","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the workflow scheme, this can be found by performing a GET `{{endpoint}}/workflow-schemes` request.

","urlObject":{"path":["workflow-schemes","{{scheme_id}}","record-types"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b0c9854a-07f2-4ba4-b5d8-ae9c2e21ab52","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-schemes/{{scheme_id}}/record-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"workflow-record-types\",\"id\":\"1\",\"links\":{\"self\":\"/backend/v1/workflow-link/view?id=1\"},\"relationships\":{\"recordtype\":{\"data\":{\"id\":1,\"type\":\"record-types\"}},\"workflow\":{\"data\":{\"id\":1,\"type\":\"workflows\"}}}}],\"links\":{\"self\":{\"href\":\"/backend/v1/workflow-schemes/1/record-types?page=1\"}},\"meta\":{\"totalCount\":1,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"95c3475e-2f2f-401a-8181-2545102e4ed4"},{"name":"Retrieve Permission Scheme Projects","id":"1739e898-95e1-4953-8eb7-94f4515a2b76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/permission-schemes/{{scheme_id}}/projects","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the permission scheme, this can be found by performing a GET `{{endpoint}}/permission-schemes` request.

","urlObject":{"path":["permission-schemes","{{scheme_id}}","projects"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1739e898-95e1-4953-8eb7-94f4515a2b76"},{"name":"Create Workflow Schemes","id":"e30324a6-373d-4f51-a506-7d31c88626e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workflow-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Workflow Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/workflow-schemes","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'workflow-schemes'
`name`	Required Name of the workflow scheme. *Must be unique
`description`	Optional Description of the workflow scheme.

","urlObject":{"path":["workflow-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"81186376-444d-47fc-9163-ba40cf155690","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workflow-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Workflow Scheme 2\",\n \"description\": \"ACE 1401 Postman Description 2\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/workflow-schemes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"workflow-schemes\",\"id\":\"4\",\"attributes\":{\"name\":\"ACE 1401 Postman Workflow Scheme 2\",\"description\":\"ACE 1401 Postman Description 2\"},\"links\":{\"self\":\"/backend/v1/scheme/view?type=workflow&id=4\"}}}"}],"_postman_id":"e30324a6-373d-4f51-a506-7d31c88626e6"},{"name":"Create Task Schemes","id":"7851cced-78a1-4b83-bcca-c034e72ffa54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"task-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Task Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/task-schemes","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`Type`	Required \"task-schemes\"
`name`	Required Name of the task scheme. *Must be unique
`description`	Optional Description of the task scheme.

","urlObject":{"path":["task-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e0ce80d4-81c2-458d-9097-0ac708bcf702","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"task-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Task Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/task-schemes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"task-schemes\",\"id\":\"0235d76c-048f-337f-a0ba-8d816134d5e0\",\"attributes\":{\"name\":\"ACE 1401 Postman Task Scheme\",\"description\":\"ACE 1401 Postman Description\"},\"links\":{\"self\":\"/backend/v1/task-schemes/0235d76c-048f-337f-a0ba-8d816134d5e0\"}}}"}],"_postman_id":"7851cced-78a1-4b83-bcca-c034e72ffa54"},{"name":"Create Calendar Schemes","id":"c6b29c96-531a-4168-986e-6c5ac4a6c774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"calendar-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Calendar Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/calendar-schemes","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`Type`	Required \"calendar-schemes\"
`name`	Required Name of the calendar scheme *`name` must be unique
`description`	Optional Description of the calendar scheme

","urlObject":{"path":["calendar-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d4e47d77-36d5-4788-9c4f-b9726b083b11","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"calendar-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Calendar Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/calendar-schemes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"calendar-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"ACE 1401 Postman Calendar Scheme\",\"description\":\"ACE 1401 Postman Description\"}}}"}],"_postman_id":"c6b29c96-531a-4168-986e-6c5ac4a6c774"},{"name":"Create Notification Schemes","id":"5f99150e-6949-4561-9a12-a2a64cef836b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"notification-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Notification Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/notification-schemes","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`Required \"notification-schemes\"
`name`	Required Name of the notification. scheme. *Must be unique
`description`	Optional Description of the notification scheme.

","urlObject":{"path":["notification-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bb420e64-f620-4b67-91c4-217e135e3791","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"notification-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Notification Scheme\",\n \"description\": \"ACE 1401 Postman Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/notification-schemes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"notification-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"ACE 1401 Postman Notification Scheme\",\"description\":\"ACE 1401 Postman Description\"}}}"}],"_postman_id":"5f99150e-6949-4561-9a12-a2a64cef836b"},{"name":"Create Permission Schemes","id":"ebda2852-d780-4ef6-9eef-c0843376f259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"permission-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Permission Scheme\",\n \"desc\": \"ACE 1401 Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/permission-schemes","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"permission-schemes\"
`name`	Required Name of the permission scheme *`name` must be unique
`description`	Optional Description of the permission scheme

","urlObject":{"path":["permission-schemes"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"7624cb94-afec-46dc-8b15-c9aba9c1638e","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"permission-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Permission Scheme\",\n \"desc\": \"ACE 1401 Postman Description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/permission-schemes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"permission-schemes\",\"id\":\"3\",\"attributes\":{\"name\":\"ACE 1401 Postman Permission Scheme\",\"desc\":\"ACE 1401 Postman Description\"}}}"}],"_postman_id":"ebda2852-d780-4ef6-9eef-c0843376f259"},{"name":"Updat Workflow Schemes","id":"1304441d-66f2-466a-a7dd-1eda9551620f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workflow-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Workflow Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}"},"url":"{{endpoint}}/workflow-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the workflow scheme, this can be found by performing a GET `{{endpoint}}/workflow-schemes` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required 'workflow-schemes'
`name`	Required Name of the workflow scheme. *Must be unique
`description`	Optional Description of the workflow scheme.

","urlObject":{"path":["workflow-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b1e65ae8-5a7c-45c3-b019-e30165ce66bd","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workflow-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Workflow Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/workflow-schemes/{{scheme_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"workflow-schemes\",\"id\":\"4\",\"attributes\":{\"name\":\"ACE 1401 Postman Workflow Scheme EDIT\",\"description\":\"ACE 1401 Postman Description EDIT\"},\"links\":{\"self\":\"/backend/v1/scheme/view?type=workflow&id=4\"}}}"}],"_postman_id":"1304441d-66f2-466a-a7dd-1eda9551620f"},{"name":"Update Task Schemes","id":"ce6c2df3-590f-4eb0-b68e-4c508d6c14a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"task-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Task Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}"},"url":"{{endpoint}}/task-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the task scheme, this can be found by performing a GET `{{endpoint}}/task-schemes` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`Type`	Required \"task-schemes\"
`name`	Required Name of the task scheme *`name` must be unique
`description`	Optional Description of the task scheme

","urlObject":{"path":["task-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"8637ab95-1822-404f-bfeb-7c5deda549f5","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"task-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Task Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/task-schemes/{{scheme_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"task-schemes\",\"id\":\"0235d76c-048f-337f-a0ba-8d816134d5e0\",\"attributes\":{\"name\":\"ACE 1401 Postman Task Scheme EDIT\",\"description\":\"ACE 1401 Postman Description EDIT\"},\"links\":{\"self\":\"/backend/v1/task-schemes/0235d76c-048f-337f-a0ba-8d816134d5e0\"}}}"}],"_postman_id":"ce6c2df3-590f-4eb0-b68e-4c508d6c14a2"},{"name":"Update Calendar Schemes","id":"1c4581af-0d48-4f67-967b-4cbb5f8b4f3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"calendar-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Calendar Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}"},"url":"{{endpoint}}/calendar-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the calendar scheme, this can be found by performing a GET `{{endpoint}}/calendar-schemes` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`Type`	Required \"calendar-schemes\"
`name`	Required Name of the calendar scheme *Must be unique
`description`	Optional Description of the calendar scheme.

","urlObject":{"path":["calendar-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"445323d4-e3e8-4407-92b1-3e4e62c9626d","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"calendar-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Calendar Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/calendar-schemes/{{scheme_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"calendar-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"ACE 1401 Postman Calendar Scheme EDIT\",\"description\":\"ACE 1401 Postman Description EDIT\"}}}"}],"_postman_id":"1c4581af-0d48-4f67-967b-4cbb5f8b4f3e"},{"name":"Update Notification Schemes","id":"a29cb5dc-da26-4320-909b-f48ed6043a9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"notification-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Notification Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}"},"url":"{{endpoint}}/notification-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the notification scheme, this can be found by performing a GET {{endpoint}}/notification-schemes request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"notification-schemes\"
`name`	Required Name of the notification scheme. *Name must be unique
`description`	Optional Description of the notification scheme.

","urlObject":{"path":["notification-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"88797999-37d5-4c9c-bee6-1965b08be399","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"notification-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Notification Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/notification-schemes/{{scheme_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"notification-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"ACE 1401 Postman Notification Scheme EDIT\",\"description\":\"ACE 1401 Postman Description EDIT\"}}}"}],"_postman_id":"a29cb5dc-da26-4320-909b-f48ed6043a9d"},{"name":"Update Permission Schemes","id":"f104bb7a-ac08-4c1e-aff2-ce9681198905","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"permission-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Permission Scheme EDIT\",\n \"desc\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}"},"url":"{{endpoint}}/permission-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the permission scheme, this can be found by performing a GET {{endpoint}}/permission-schemes request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"permission-schemes\"
`name`	Required Name of the permission scheme. *Must be unique
`desc`	Optional Description of the permission scheme.

","urlObject":{"path":["permission-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"316ceb9c-416b-49e4-bdfe-2f7d13089772","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"notification-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Notification Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/notification-schemes/{{scheme_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"notification-schemes\",\"id\":\"2\",\"attributes\":{\"name\":\"ACE 1401 Postman Notification Scheme EDIT\",\"description\":\"ACE 1401 Postman Description EDIT\"}}}"}],"_postman_id":"f104bb7a-ac08-4c1e-aff2-ce9681198905"},{"name":"Delete Workflow Schemes","id":"caf45dbd-9b73-492b-9915-ca21c5376193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/workflow-schemes/{{scheme_id}}","description":"

A workflow scheme cannot be deleted if it is in use.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the workflow scheme, this can be found by performing a GET `{{endpoint}}/workflow-schemes` request.

","urlObject":{"path":["workflow-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"2355e0d6-e093-495b-9c11-79fa311d2563","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workflow-schemes\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Workflow Scheme EDIT\",\n \"description\": \"ACE 1401 Postman Description EDIT\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/workflow-schemes/{{scheme_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"caf45dbd-9b73-492b-9915-ca21c5376193"},{"name":"Delete Task Schemes","id":"3ed91e43-7421-4fbc-95b6-3b7bb9dc4bf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/task-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the task scheme, this can be found by performing a GET `{{endpoint}}/task-schemes` request.

","urlObject":{"path":["task-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"627cc1f8-03b1-474a-be8e-e6964de905e1","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/task-schemes/{{scheme_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3ed91e43-7421-4fbc-95b6-3b7bb9dc4bf7"},{"name":"Delete Calendar Schemes","id":"8c655fcc-9de2-4869-80e4-ccabbb4e6745","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/calendar-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the calendar scheme, this can be found by performing a GET `{{endpoint}}/calendar-schemes` request.

","urlObject":{"path":["calendar-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"04887618-aafe-4910-8a41-26c922720cfa","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/calendar-schemes/{{scheme_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8c655fcc-9de2-4869-80e4-ccabbb4e6745"},{"name":"Delete Notification Schemes","id":"fbd3782d-76de-4761-93d4-68feb16ea2cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/notification-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the notification scheme, this can be found by performing a GET `{{endpoint}}/notification-schemes` request.

","urlObject":{"path":["notification-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9520a1b9-76d7-4610-aeee-b5d692cac2ba","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/notification-schemes/{{scheme_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fbd3782d-76de-4761-93d4-68feb16ea2cb"},{"name":"Delete Permission Schemes","id":"b5727c6f-8d30-4893-a7f0-4d1d5730500a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/permission-schemes/{{scheme_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`scheme_id`	Required The assigned ID for the permission scheme, this can be found by performing a GET `{{endpoint}}/permission-schemes` request.

","urlObject":{"path":["permission-schemes","{{scheme_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"eea5f40a-6ea1-4788-ae93-6d17c261e9b8","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/permission-schemes/{{scheme_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b5727c6f-8d30-4893-a7f0-4d1d5730500a"}],"id":"a46bf0d3-abe4-4c02-b28d-6133390f71f5","description":"

Workflow schemes: A scheme used to associate workflows with record types.
Calendar schemes: A scheme used to trigger workflow events for a project to appear in the calendar.
Task schemes: A scheme used to correlate tasks to a project.
Notification schemes: A scheme used to send notifications to users when workflow events are triggered.
Permission schemes: A sheme used to assign users, groups, project roles, custom fields, and project leads permissions to a project. The following is a list of all of the permissions that can be assigned within the scheme:
- Administer Projects- Users with this permission will have access to the Administration icon and will be able to edit the name, key, description, and record view of a project.
- Create Records- Users will be able to create records for the project.
- Edit Records- Users will be able to edit existing records for the project.
- View Records- Users will be able to view existing record for the project.
- Delete Data Records- Users will be able to delete records that are of the \"Data\" workflow type.
- Insert Object Data- Users will be able to add object data for the record.
- Export Report (PDF)- Users will be able to export a report in PDF form.
- Export Report (DOC)- Users will be able to export a report in DOC form.
- Add Comments- Users will be able to add comments to a record.
- Edit Own Comments- Users will be able to edit their own comments on a record.
- Edit All Comments- Users will be able to edit all comments on a record.
- Delete Own Comments- Users will be able to delete their own comments on a record.
- Delete All Comments- Users will be able to delete all comments on a record.
- Add Attachments- Users will be able to add attachments to a record.
- Delete Own Attachments- Users will be able to delete their own attachments on a record.
- Delete All Attachments- Users will be able to delete all attachments on a record.
- Download Attachment- Users will be able to download an attachment.
- View Audit Trail - Users will be able to view the audit trail.
- Review Audit Trail - Users will be able to review the audit trail.
\n

\n","event":[{"listen":"prerequest","script":{"id":"b495aa70-cfb0-4f31-b330-ea8b8dcb879f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c76578ec-afd6-4858-865a-4b7d7e1ddc6f","type":"text/javascript","exec":[""]}}],"_postman_id":"a46bf0d3-abe4-4c02-b28d-6133390f71f5"},{"name":"Sites","item":[{"name":"Retrieve All Sites","id":"3a61c3bc-7423-4462-b56c-fc1ce3f2dd45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sites","urlObject":{"path":["sites"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"c9f0d554-1fd6-479a-bd50-c9d4d3aa0d7a","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"sites\",\n \"id\": \"72\",\n \"attributes\": {\n \"name\": \"25bc9c91-0930-37e7-b2e6-32356445a119\",\n \"description\": \"Testing site description\",\n \"text\": \"Testing site\",\n \"data\": null\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/sites?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 6,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"3a61c3bc-7423-4462-b56c-fc1ce3f2dd45"},{"name":"Search Sites","id":"d0d83ff1-4361-4d36-a857-0a6ef6b622a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, name from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/sites/search","description":"

Returns a list of sites.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["sites","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"55a11565-b104-43ba-b91e-f826902f10dd","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/sites/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":[{\"type\":\"sites\",\"id\":\"62\",\"attributes\":{\"name\":\"923cd0d4-1cfa-3483-ab08-c0ea813a58b4\",\"description\":\"Testing site description\",\"text\":\"Testing site 1 (ID:62)\",\"data\":{\"siteId\":\"Test\",\"location\":\"Test\"}}},{\"type\":\"sites\",\"id\":\"52\",\"attributes\":{\"name\":\"95e2a803-b9ed-34e1-bb66-7b73ac224888\",\"description\":\"Testing site description EDIT (ID:52)\",\"text\":\"Testing site EDIT2 (ID:52)\",\"data\":{\"siteId\":\"Test EDIT (ID:52)\",\"location\":\"Test EDIT (ID:52)\"}}},{\"type\":\"sites\",\"id\":\"59\",\"attributes\":{\"name\":\"e943c881-de40-353f-b120-7c1b0023842f\",\"description\":\"Testing site description\",\"text\":\"Testing site (ID:59)\",\"data\":null}}],\"links\":{\"self\":{\"href\":\"/backend/v1/sites/search?page=1\"}},\"meta\":{\"totalCount\":3,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"d0d83ff1-4361-4d36-a857-0a6ef6b622a7"},{"name":"Create Sites","id":"15f4ecfa-891b-436b-965f-c2e37dcdf7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"sites\",\n \"attributes\": {\n \"text\": \"Testing site\",\n \"description\": \"Testing site description\",\n \"data\": {\n \"siteId\": \"Test\",\n \"location\": \"Test\"\n }\n }\n }\n}"},"url":"{{endpoint}}/sites","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"sites\"
`name`	Required Name of the site. *Must be unique
`description`	Optional Description of the site.
`siteId`	Optional ID of the site.
`location`	Optional Location of the site.

","urlObject":{"path":["sites"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3cded792-7c2c-4e01-8d4c-ed7588c50b6c","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\":\"sites\",\n\t\t\"attributes\": {\n\t\t\t\"text\": \"Testing site 1\",\n\t\t\t\"description\":\"Testing site description\",\n\t\t\t\"data\": {\n\t\t\t\t\"siteId\":\"Test\",\n\t\t\t\t\"location\":\"Test\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/sites"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"sites\",\"id\":\"62\",\"attributes\":{\"name\":\"923cd0d4-1cfa-3483-ab08-c0ea813a58b4\",\"description\":\"Testing site description\",\"text\":\"Testing site 1\",\"data\":{\"siteId\":\"Test\",\"location\":\"Test\"}}}}"}],"_postman_id":"15f4ecfa-891b-436b-965f-c2e37dcdf7b6"},{"name":"Update Sites","id":"b3996cab-c6ff-41dc-92b0-edc54157347a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"sites\",\n \"attributes\": {\n \"text\": \"Testing site EDIT\",\n \"description\": \"Testing site description EDIT\",\n \"data\": {\n \"siteId\": \"Test EDIT\",\n \"location\": \"Test EDIT\"\n }\n }\n }\n}"},"url":"{{endpoint}}/sites/{{site_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`site_id`	Required The assigned ID for the site, this can be found by performing a GET `{{endpoint}}/sites` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"sites\"
`name`	Required Name of the site. *Must be unique
`description`	Optional Description of the site.
`siteId`	Optional ID of the site.
`location`	Optional Location of the site.

","urlObject":{"path":["sites","{{site_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"0043bc51-ce9f-4f75-bd8e-a0a201f8f9da","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"sites\",\n \"attributes\": {\n \"text\": \"Testing site EDIT2 (ID:52)\",\n \"description\": \"Testing site description EDIT (ID:52)\",\n \"data\": {\n \"siteId\": \"Test EDIT (ID:52)\",\n \"location\": \"Test EDIT (ID:52)\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/sites/{{site_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"data\":{\"type\":\"sites\",\"id\":\"52\",\"attributes\":{\"name\":\"95e2a803-b9ed-34e1-bb66-7b73ac224888\",\"description\":\"Testing site description EDIT (ID:52)\",\"text\":\"Testing site EDIT2 (ID:52)\",\"data\":{\"siteId\":\"Test EDIT (ID:52)\",\"location\":\"Test EDIT (ID:52)\"}}}}"}],"_postman_id":"b3996cab-c6ff-41dc-92b0-edc54157347a"},{"name":"Delete Sites","id":"96ee227d-d0e2-4f78-9cc1-5bd50e2b4d1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/sites/{{site_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`site_id`	Required The assigned ID for the site, this can be found by performing a GET `{{endpoint}}/sites` request.

","urlObject":{"path":["sites","{{site_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"12de9f60-8380-4816-9a11-fd8acdf47737","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint}}/sites/{{site_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"96ee227d-d0e2-4f78-9cc1-5bd50e2b4d1f"}],"id":"a2897574-2328-475f-bde3-326300948a7b","description":"

Sites are specified locations that a company is working from.

\n","event":[{"listen":"prerequest","script":{"id":"f3912b40-bb7f-4f36-bcca-4bee6073cc75","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2aefa07-885b-4aa6-9dc5-cf2d18f43239","type":"text/javascript","exec":[""]}}],"_postman_id":"a2897574-2328-475f-bde3-326300948a7b"},{"name":"System Log","item":[{"name":"Retrieve All System Logs","id":"c9e5605d-d0b2-4182-8e70-96a96dc4e67a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sys-logs","urlObject":{"path":["sys-logs"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"a87ce4a0-1f59-421e-991a-99634cf2af64","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sys-logs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"sys-logs\",\n \"id\": \"1\",\n \"attributes\": {\n \"module\": \"user\",\n \"model\": \"User\",\n \"action\": \"login\",\n \"controller\": \"login\",\n \"model_id\": -1,\n \"dateAdded\": \"2017-01-17T16:46:16+0000\",\n \"user_id\": -1,\n \"assoc_model\": null,\n \"assoc_id\": null\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/sys-logs?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/sys-logs?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/sys-logs?page=1549\"\n }\n },\n \"meta\": {\n \"totalCount\": 30972,\n \"pageCount\": 1549,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"c9e5605d-d0b2-4182-8e70-96a96dc4e67a"},{"name":"Retrieve System Log Details","id":"08f0d21f-d570-44ad-bda9-127807ad5f84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sys-logs/{{sys_log_id}}/details","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`sys_log_id`	Required The assigned ID for the system log, this can be found by performing a GET `{{endpoint}}/sys-log` request.

","urlObject":{"path":["sys-logs","{{sys_log_id}}","details"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"95c8df88-1761-4b63-8d79-bc716e593c1d","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sys-logs/{{sys_log_id}}/details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"sys-log-fields\",\n \"id\": \"53\",\n \"attributes\": {\n \"field\": \"type\",\n \"old_value\": \"\",\n \"old_text\": \"\",\n \"new_value\": \"radioButtonList\",\n \"new_text\": \"radioButtonList\"\n }\n },\n {\n \"type\": \"sys-log-fields\",\n \"id\": \"54\",\n \"attributes\": {\n \"field\": \"module\",\n \"old_value\": \"\",\n \"old_text\": \"\",\n \"new_value\": \"form\",\n \"new_text\": \"form\"\n }\n },\n {\n \"type\": \"sys-log-fields\",\n \"id\": \"55\",\n \"attributes\": {\n \"field\": \"label\",\n \"old_value\": \"\",\n \"old_text\": \"\",\n \"new_value\": \"Subject\",\n \"new_text\": \"Subject\"\n }\n },\n {\n \"type\": \"sys-log-fields\",\n \"id\": \"56\",\n \"attributes\": {\n \"field\": \"name\",\n \"old_value\": \"\",\n \"old_text\": \"\",\n \"new_value\": \"cf_subject\",\n \"new_text\": \"cf_subject\"\n }\n },\n {\n \"type\": \"sys-log-fields\",\n \"id\": \"57\",\n \"attributes\": {\n \"field\": \"data\",\n \"old_value\": \"\",\n \"old_text\": \"\",\n \"new_value\": \"a\",\n \"new_text\": \"a\"\n }\n },\n {\n \"type\": \"sys-log-fields\",\n \"id\": \"58\",\n \"attributes\": {\n \"field\": \"id\",\n \"old_value\": \"\",\n \"old_text\": \"\",\n \"new_value\": \"8\",\n \"new_text\": \"8\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/sys-logs/11/details?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 6,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"08f0d21f-d570-44ad-bda9-127807ad5f84"},{"name":"Search System Logs","id":"e392a0ec-0ae0-4935-9ac9-8baf6ab6985a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select model, action, ip_address, user_id from __main__ where action like \\\"login\\\" OR action like \\\"logout\\\"\"\n}"},"url":"{{endpoint}}/sys-logs/search","description":"

Return system logs based on search criteria.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["sys-logs","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e392a0ec-0ae0-4935-9ac9-8baf6ab6985a"}],"id":"a9e1f3a4-405d-47bd-8e0c-973a3dbeeb04","description":"

System log is a list of all user activities in the system. The system log tracks user login, metadata recorded on a record, and record/document signatures on a record. The system log will track POST, PATCH and DEL API calls.

\n","event":[{"listen":"prerequest","script":{"id":"0939362e-bbbc-4004-a255-4dd609dfc388","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94cba8fd-e32b-4619-aadd-0d7c7124878c","type":"text/javascript","exec":[""]}}],"_postman_id":"a9e1f3a4-405d-47bd-8e0c-973a3dbeeb04"},{"name":"System Settings","item":[{"name":"Retrieve All System Settings","id":"932271a8-a697-4c03-8c2b-07d465f4dcd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sys-settings","urlObject":{"path":["sys-settings"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"932271a8-a697-4c03-8c2b-07d465f4dcd0"},{"name":"Retrieve System Setting","id":"f45bc8ed-9d4c-47b8-b5de-c0ed7dfcfaab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/sys-settings/{{setting_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`setting_id`	Required The assigned ID for the system setting, this can be found by performing a GET `{{endpoint}}/sys-settings` request.

","urlObject":{"path":["sys-settings","{{setting_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f45bc8ed-9d4c-47b8-b5de-c0ed7dfcfaab"},{"name":"Update System Setting","id":"d4da4f19-b62c-440a-9389-6d6f78a1d14c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"sys-settings\",\n \"attributes\": {\n \"value\": {{value}}\n }\n }\n}"},"url":"{{endpoint}}/sys-settings/{{setting_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`setting_id`	Required The assigned ID for the system setting, this can be found by performing a GET `{{endpoint}}/sys-settings` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"sys-settings\"
`value`	Required Value of the system setting updated.

","urlObject":{"path":["sys-settings","{{setting_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"55b28879-3d84-4b51-bbbf-5cdfbc10fe87","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"sys-settings\",\"id\":\"datetime_weekStart\",\"attributes\":{\"value\":\"1\"}}}"},"url":"{{endpoint}}/sys-settings/datetime_weekStart"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"sys-settings\",\"id\":\"datetime_weekStart\",\"attributes\":{\"value\":\"1\"}}}"}],"_postman_id":"d4da4f19-b62c-440a-9389-6d6f78a1d14c"}],"id":"63ea2329-918b-42a9-bcce-b85904e25213","description":"

System setting is used to customize the speficiation of the system.

\n","event":[{"listen":"prerequest","script":{"id":"05f7745f-1998-44dd-bd8c-3a0e99e84cad","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"769a5bd2-af8b-4da2-ad16-467299024da7","type":"text/javascript","exec":[""]}}],"_postman_id":"63ea2329-918b-42a9-bcce-b85904e25213"},{"name":"Training Roles","item":[{"name":"Retrieve All Training Roles","id":"62116a30-ffe2-44c5-a696-9a4dcd838b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/training-roles","urlObject":{"path":["training-roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d1577677-5f9f-4b72-9d1e-a5225c1507bf","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/training-roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"training-roles\",\n \"id\": \"4\",\n \"attributes\": {\n \"name\": \"General All Workforce\",\n \"desc\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/training-roles?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/training-roles?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/training-roles?page=4\"\n }\n },\n \"meta\": {\n \"totalCount\": 65,\n \"pageCount\": 4,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"62116a30-ffe2-44c5-a696-9a4dcd838b74"},{"name":"Retrieve All Users in Training Role","id":"428478d7-0931-429d-8813-7c4c9970f304","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/training-roles/{{training_role_id}}/users","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`training_role_id`	Required The assigned ID for the training role, this can be found by performing a GET `{{endpoint}}/training-roles` request.

","urlObject":{"path":["training-roles","{{training_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bec3406f-cba9-4b8b-86b8-8389384d7aba","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/training-roles/{{training_role_id}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"users\",\n \"id\": \"165\",\n \"attributes\": {\n \"username\": \"tester\",\n \"failed_attempts\": 0,\n \"last_failed_date\": null,\n \"latest_activity_date\": null,\n \"status\": 1,\n \"latest_login_date\": \"2018-01-23T01:10:26+0000\"\n },\n \"links\": {\n \"self\": \"/backend/v1/users/165\"\n },\n \"relationships\": {\n \"person\": {\n \"data\": {\n \"id\": 165,\n \"type\": \"people\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/training-roles/4/users?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/training-roles/4/users?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/training-roles/4/users?page=21\"\n }\n },\n \"meta\": {\n \"totalCount\": 411,\n \"pageCount\": 21,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"428478d7-0931-429d-8813-7c4c9970f304"},{"name":"Create Training Roles","id":"cafbddc3-a266-4dcf-ac38-48fef418bfdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"training-roles\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Training Role\",\n \"desc\": \"Postman Description\"\n }\n }\n}"},"url":"{{endpoint}}/training-roles","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"training-roles\"
`name`	Required Name of the training role. *Must be unique
`desc`	Optionsl Description of the training role.

","urlObject":{"path":["training-roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cafbddc3-a266-4dcf-ac38-48fef418bfdc"},{"name":"Add Users to Training Roles","id":"4a1c3147-33e1-4a55-ae22-db9aa1100718","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/training-roles/{{training_role_id}}/users","description":"

Add user(s) to a training role if none of the user(s) were already assigned to the training role. Replaces existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`training_role_id`	Required The assigned ID for the training role, this can be found by performing a GET `{{endpoint}}/training-roles` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"training-roles\"
`id`	Required `user_id` The assigned ID for a user, this can be found by performing a GET `{{endpoint}}/users` request.

","urlObject":{"path":["training-roles","{{training_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a1c3147-33e1-4a55-ae22-db9aa1100718"},{"name":"Update Training Roles","id":"07d16566-da20-46d2-8806-85d2f4bffce1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"training-roles\",\n \"attributes\": {\n \"name\": \"ACE 1401 Postman Training Role X\",\n \"desc\": \"Postman Description X\"\n }\n }\n}"},"url":"{{endpoint}}/training-roles/{{training_role_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`training_role_id`	Required The assigned ID for the training role, this can be found by performing a GET `{{endpoint}}/training-roles` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"training-roles\"
`name`	Required Name of the training role. *Must be unique
`desc`	Optional Description of the training role.

","urlObject":{"path":["training-roles","{{training_role_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"07d16566-da20-46d2-8806-85d2f4bffce1"},{"name":"Update Users in Training Roles","id":"d023d129-18e2-42ec-b763-eada9969c8fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": {{user_id}},\n \"type\": \"users\"\n }\n ]\n}"},"url":"{{endpoint}}/training-roles/{{training_role_id}}/users","description":"

Adds user(s) to the training role if none of the selected user(s) are already assigned to the training role. Appends to existing users if successful.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`training_role_id`	Required The assigned ID for the training role, this can be found by performing a GET `{{endpoint}}/training-roles` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"training-roles\"
`id`	Required `user_id` The assigned ID for a user, this can be found by performing a GET `{{endpoint}}/users` request.

","urlObject":{"path":["training-roles","{{training_role_id}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d023d129-18e2-42ec-b763-eada9969c8fe"},{"name":"Delete Training Roles","id":"51dd2c5d-9a35-4629-9fde-c07512cb256a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/training-roles/{{training_role_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`training_role_id`	Required The assigned ID for the training role, this can be found by performing a GET `{{endpoint}}/training-roles` request.

","urlObject":{"path":["training-roles","{{training_role_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51dd2c5d-9a35-4629-9fde-c07512cb256a"},{"name":"Remove Users in Training Roles","id":"b0359629-066d-4e7e-91c2-167169882256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/training-roles/{{training_role_id}}/users","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`training_role_id`	Required The assigned ID for the training role, this can be found by performing a GET `{{endpoint}}/training-roles` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`id`	Required `user_id` The assigned ID for the users, this can be found by performing a GET `{{endpoint}}/users` request.
`type`	Required \"users\"

Training roles are groups of user which need to complete the same training material.

\n","event":[{"listen":"prerequest","script":{"id":"5e331d00-c58e-42a9-8c58-5698c6928771","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6825ff18-8844-4b2b-954b-0ed0b73cb6bd","type":"text/javascript","exec":[""]}}],"_postman_id":"ee0a2f7c-05dc-42bd-81ea-b222b2c2f61c"},{"name":"Users","item":[{"name":"Retrieve All Users","id":"ff4b9799-4782-4a25-a6de-aa997745ec13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users","urlObject":{"path":["users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"04dd998d-b34f-46d7-b508-bd3906806a4b","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"username\": \"testuser2\",\n \"person_id\": \"635\",\n \"password\": \"testing.password\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"users\",\"id\":\"615\",\"attributes\":{\"username\":\"testuser2\",\"failed_attempts\":null,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":null,\"latest_login_date\":null},\"links\":{\"self\":\"/backend/v1/users/615\"},\"relationships\":{\"person\":{\"data\":{\"id\":\"635\",\"type\":\"people\"}}}}}"}],"_postman_id":"ff4b9799-4782-4a25-a6de-aa997745ec13"},{"name":"Retrieve All User Permissions","id":"21a23a36-74ae-4ca3-884a-1b162555cf89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/permissions","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`user_id`	Required The assigned ID for the user, this can be found by performing a GET {{endpoint}}/users request.

","urlObject":{"path":["users","{{user_id}}","permissions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"fbdcf278-172a-4ba4-b4f2-0b31bfe2bf60","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"generic\",\"id\":\"5a666f6a75b8b\",\"attributes\":{\"name\":\"global_admin\",\"description\":\"Ability to perform most user & group administration functions.
Note: People with this permission can always log in.\",\"text\":\"Administrators\"}},{\"type\":\"generic\",\"id\":\"5a666f6a75c0e\",\"attributes\":{\"name\":\"global_api\",\"description\":\"ACE API\",\"text\":\"API\"}},{\"type\":\"generic\",\"id\":\"5a666f6a75c84\",\"attributes\":{\"name\":\"global_bulkChange\",\"description\":\"Ability to modify a collection of records at once.\",\"text\":\"Bulk Change\"}},{\"type\":\"generic\",\"id\":\"5a666f6a75cfe\",\"attributes\":{\"name\":\"global_createSharedObjects\",\"description\":\"Ability to share data such as calendars, dashboards and filters with other users.\",\"text\":\"Create Shared Objects\"}},{\"type\":\"generic\",\"id\":\"5a666f6a75d91\",\"attributes\":{\"name\":\"global_sysadmin\",\"description\":\"Ability to perform all administration functions. There must be at least one group with this permission.
Note: People with this permission can always log in.\",\"text\":\"System Administrators\"}},{\"type\":\"generic\",\"id\":\"5a666f6a75e05\",\"attributes\":{\"name\":\"global_user\",\"description\":\"Ability to log in to the system. All users need this permission to be able to log in, even if they have other permissions.\",\"text\":\"Users\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/users/1/permissions?page=1\"}},\"meta\":{\"totalCount\":7,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"21a23a36-74ae-4ca3-884a-1b162555cf89"},{"name":"Retrieve All User Project Roles","id":"04ca1b06-e721-488b-9e65-078507add720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/project-roles","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`user_id`	Required The assigned ID for the user, this can be found by performing a GET `{{endpoint}}/users` request.

","urlObject":{"path":["users","{{user_id}}","project-roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"983ae0a8-8d92-490c-a2f4-8acb915ebbe6","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/project-roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[],\"links\":{\"self\":{\"href\":\"/backend/v1/users/1/project-roles?page=1\"}},\"meta\":{\"totalCount\":0,\"pageCount\":0,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"04ca1b06-e721-488b-9e65-078507add720"},{"name":"Retrieve All User Training Roles","id":"7a4372ae-71c1-4b0d-a1f5-c4302efcd6b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/training-roles","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`user_id`	Required The assigned ID for the user, this can be found by performing a GET `{{endpoint}}/users` request.

","urlObject":{"path":["users","{{user_id}}","training-roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"43ef966c-6e02-4e24-818b-df06cf5877db","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/training-roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"training-roles\",\"id\":\"4\",\"attributes\":{\"name\":\"General All Workforce\",\"desc\":\"\"}},{\"type\":\"training-roles\",\"id\":\"5\",\"attributes\":{\"name\":\"General GxP\",\"desc\":\"\"}},{\"type\":\"training-roles\",\"id\":\"33\",\"attributes\":{\"name\":\"Quality Systems\",\"desc\":\"\"}},{\"type\":\"training-roles\",\"id\":\"37\",\"attributes\":{\"name\":\"Quality Clinical QA\",\"desc\":\"\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/users/1/training-roles?page=1\"}},\"meta\":{\"totalCount\":4,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"7a4372ae-71c1-4b0d-a1f5-c4302efcd6b3"},{"name":"Retrieve All User Settings","id":"a7213c09-0e7e-4c10-8791-650c750e700b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/settings","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`user_id`	Required The assigned ID for the user, this can be found by performing a GET `{{endpoint}}/users` request.

","urlObject":{"path":["users","{{user_id}}","settings"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"e8780bb0-0947-4a6b-8dcf-46e3dc3dde98","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/settings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":[{\"type\":\"generic\",\"id\":\"5a666fb4bf5ce\",\"attributes\":{\"name\":\"datetime_timezone\",\"value\":\"America/Los_Angeles\"}},{\"type\":\"generic\",\"id\":\"5a666fb4bf657\",\"attributes\":{\"name\":\"document_view\",\"value\":\"list\"}},{\"type\":\"generic\",\"id\":\"5a666fb4bf6c8\",\"attributes\":{\"name\":\"last_dash_viewed\",\"value\":\"1\"}},{\"type\":\"generic\",\"id\":\"5a666fb4bf737\",\"attributes\":{\"name\":\"menu_shortcuts\",\"value\":\"[]\"}},{\"type\":\"generic\",\"id\":\"5a666fb4bf7a5\",\"attributes\":{\"name\":\"workflow_viewMode\",\"value\":\"text\"}}],\"links\":{\"self\":{\"href\":\"/backend/v1/users/1/settings?page=1\"}},\"meta\":{\"totalCount\":5,\"pageCount\":1,\"currentPage\":1,\"perPage\":20}}"}],"_postman_id":"a7213c09-0e7e-4c10-8791-650c750e700b"},{"name":"Retrieve All User Groups","id":"4a3be855-0918-495c-862c-380d644377cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/groups","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`user_id`	Required The assigned ID for the user, this can be found by performing a GET `{{endpoint}}/users` request.

","urlObject":{"path":["users","{{user_id}}","groups"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"30ea87ea-06ce-4cb0-8e0e-ff62402727b3","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/users/{{user_id}}/groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"groups\",\n \"id\": \"66\",\n \"attributes\": {\n \"name\": \"31cbf25d-68c8-3b41-9bf5-680706c54ef6\",\n \"description\": null,\n \"text\": \"updated text\"\n },\n \"links\": {\n \"self\": \"/backend/v1/groups/66\"\n },\n \"relationships\": {\n \"site\": {\n \"data\": {\n \"id\": 43,\n \"type\": \"sites\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/users/1/groups?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/users/1/groups?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/users/1/groups?page=2\"\n }\n },\n \"meta\": {\n \"totalCount\": 23,\n \"pageCount\": 2,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"4a3be855-0918-495c-862c-380d644377cd"},{"name":"Search Users","id":"ea8f4b4e-ffd8-4ffa-9d3d-7b346dfe6085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, username from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/users/search","description":"

Returns a list of users.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["users","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"93726091-d89e-4b1b-a81a-bf0d1b4dcefd","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, username from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/users/search"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ea8f4b4e-ffd8-4ffa-9d3d-7b346dfe6085"},{"name":"Create Users","id":"8e59f978-c2f7-4b35-8f12-bf0357653c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"username\": \"testuser2\",\n \"person_id\": \"635\",\n \"password\": \"testing.password\"\n }\n }\n}"},"url":"{{endpoint}}/users","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`type`	Required \"users\"
`username`	Required Name of the new user. *Must be unique, between 3 - 50 characters, and may only contain alphanumeric characters, hyphens and/or underlines
`person_id`	Required `person_id` The ID of the person associated with the user,this can be found by performing a GET `{{endpoint}}/people` request. *Must be unique
`password`	Required Password for the user. *Password requirments depends on what security mode is configured for the system by the ACE System Administrator

","urlObject":{"path":["users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"317abe2d-eae4-433b-84cb-4f3d53beaa9e","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"users\",\"attributes\":{\"username\":\"testuser2\",\"person_id\":\"635\",\"password\":\"testing.password\"}}}"},"url":"{{endpoint}}/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"users\",\"id\":\"615\",\"attributes\":{\"username\":\"testuser2\",\"failed_attempts\":null,\"last_failed_date\":null,\"latest_activity_date\":null,\"status\":null,\"latest_login_date\":null},\"links\":{\"self\":\"/backend/v1/users/615\"},\"relationships\":{\"person\":{\"data\":{\"id\":\"635\",\"type\":\"people\"}}}}}"}],"_postman_id":"8e59f978-c2f7-4b35-8f12-bf0357653c1d"},{"name":"Update Users","id":"f2b52ffa-d1c6-413d-b417-727bba9527f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"username\": \"newuser\"\n }\n }\n}"},"url":"{{endpoint}}/users/{{user_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`user_id`	Required The assigned ID for the user, this can be found by performing a GET `{{endpoint}}/users` request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`username`	Required ID of the account *`username` must be unique. `username` also must be between 3 - 50 characters, and must contain only alphanumeric characters and/or hyphens and underlines
`person_id`	Required ID of the person associated with the user. *`person_id` must be unique
`password`	Required Password for the user. *Password requirments depends on what security mode is configured for the system by the ACE System Administrator

","urlObject":{"path":["users","{{user_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2b52ffa-d1c6-413d-b417-727bba9527f1"}],"id":"782faa5e-af54-4c44-a346-03d0ab16a935","description":"

Users are the individuals who interact with the system.

\n","event":[{"listen":"prerequest","script":{"id":"6b085678-cc5d-4108-966e-5e404dc0c37c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8403bdd9-f48b-4a60-9a47-77e0c2fabcc0","type":"text/javascript","exec":[""]}}],"_postman_id":"782faa5e-af54-4c44-a346-03d0ab16a935"},{"name":"Workflows","item":[{"name":"Retrieve All Workflows","id":"3b4a5409-12da-40fd-8a78-597cccaf3834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflows","description":"

Returns a list of all workflows.

\n","urlObject":{"path":["workflows"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"403d8d73-e9f1-4c07-9368-0c9c41dac14c","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflows"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflows\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"MRF\",\n \"description\": \"\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflows/1\"\n },\n \"relationships\": {\n \"histories\": {\n \"data\": {\n \"id\": [\n 1\n ],\n \"type\": \"workflow-histories\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflows?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 9,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"3b4a5409-12da-40fd-8a78-597cccaf3834"},{"name":"Retrieve Workflow","id":"b301d42f-2722-43db-8866-4f71d7e90b3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflows/{{workflow_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`workflow_id`	Required The assigned ID for the workflow, this can be found by performing a GET `{{endpoint}}/workflows` request.

","urlObject":{"path":["workflows","{{workflow_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"a8a9facd-3432-471a-a38e-a66499a46f1a","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflows/{{workflow_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"workflows\",\"id\":\"1\",\"attributes\":{\"name\":\"MRF\",\"description\":\"\"},\"links\":{\"self\":\"/backend/v1/workflows/1\"},\"relationships\":{\"histories\":{\"data\":{\"id\":[1],\"type\":\"workflow-histories\"}}}}}"}],"_postman_id":"b301d42f-2722-43db-8866-4f71d7e90b3d"},{"name":"Retrieve All Workflow History","id":"6da0a4a1-8e0d-42f1-aa72-9db9575060fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories","urlObject":{"path":["workflow-histories"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bd534eb1-aaee-492b-8d84-efda5d80a6bc","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-histories\",\n \"id\": \"1\",\n \"attributes\": {\n \"is_current\": true,\n \"is_draft\": false,\n \"version\": 1,\n \"last_updated\": \"2017-01-17T18:42:48+0000\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflow-histories/1\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": -1,\n \"type\": \"users\"\n }\n },\n \"workflow\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"workflows\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflow-histories?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/workflow-histories?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/workflow-histories?page=2\"\n }\n },\n \"meta\": {\n \"totalCount\": 21,\n \"pageCount\": 2,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"6da0a4a1-8e0d-42f1-aa72-9db9575060fe"},{"name":"Retrieve Workflow History","id":"c9f23c78-bf57-4413-86c8-640fd1c937fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories/{{workflow_histories_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`workflow_histories_id`	Required The assigned ID for the workflow history, this can be found by performing a GET `{{endpoint}}/workflow-histories` request.

","urlObject":{"path":["workflow-histories","{{workflow_histories_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"2608bbc4-5357-4ad5-8ec4-f90f1f724856","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories/{{workflow_histories_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"workflow-histories\",\"id\":\"1\",\"attributes\":{\"is_current\":true,\"is_draft\":false,\"version\":1,\"last_updated\":\"2017-01-17T18:42:48+0000\"},\"links\":{\"self\":\"/backend/v1/workflow-histories/1\"},\"relationships\":{\"user\":{\"data\":{\"id\":-1,\"type\":\"users\"}},\"workflow\":{\"data\":{\"id\":1,\"type\":\"workflows\"}}}}}"}],"_postman_id":"c9f23c78-bf57-4413-86c8-640fd1c937fc"},{"name":"Retrieve All Workflow Steps of History","id":"a9d2f3f4-79c9-4d46-8390-aae5c2d180bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories/{{workflow_history_id}}/steps","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`workflow_histories_id`	Required The assigned ID for the workflow history, this can be found by performing a GET `{{endpoint}}/workflow-histories` request.

","urlObject":{"path":["workflow-histories","{{workflow_history_id}}","steps"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5a3bf9a4-f356-4a44-b7fc-1d01050b27de","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories/{{workflow_history_id}}/steps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-steps\",\n \"id\": \"1\",\n \"attributes\": {\n \"text\": \"Start\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflow-steps/1\"\n },\n \"relationships\": {\n \"linkedState\": {\n \"data\": {\n \"id\": -1,\n \"type\": \"record-states\"\n }\n },\n \"workflowHistory\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"workflow-histories\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflow-histories/1/steps?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 9,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"a9d2f3f4-79c9-4d46-8390-aae5c2d180bf"},{"name":"Retrieve All Transitions of History","id":"18ed8db2-225c-4214-8a11-47faea8aa101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories/{{workflow_history_id}}/transitions","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`workflow_histories_id`	Required The assigned ID for the workflow history, this can be found by performing a GET `{{endpoint}}/workflow-histories` request.

","urlObject":{"path":["workflow-histories","{{workflow_history_id}}","transitions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5f6040b4-dedc-4289-961b-bc6e0ffea703","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-histories/{{workflow_history_id}}/transitions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-transitions\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Create\",\n \"description\": \"This is the initial transition in the workflow\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflow-transitions/1\"\n },\n \"relationships\": {\n \"sourceStep\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"workflow-steps\"\n }\n },\n \"destinationStep\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"workflow-steps\"\n }\n },\n \"view\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"forms\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflow-histories/1/transitions?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 13,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"18ed8db2-225c-4214-8a11-47faea8aa101"},{"name":"Search Workflows","id":"d2c75402-7ffb-4fec-91e2-553d07f4060a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, name from __main__ where id eq 1\"\n}"},"url":"{{endpoint}}/workflows/search","description":"

Returns a list of workflows.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`aql`	Optional ACE Query Language for searching. Refer to the 'Filters' section for more details.

","urlObject":{"path":["workflows","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2c75402-7ffb-4fec-91e2-553d07f4060a"}],"id":"89675daf-b4d6-4a91-93f3-2239b5037e6e","description":"

Workflow describes the path that a record type follows throughout its life cycle. Workflows consist of record states with transitions. The transitions between record states can be configured to gather data, check signatures, verify conditions, and with many other powerful tools.

\n","event":[{"listen":"prerequest","script":{"id":"9433c08f-1df8-40e1-a799-3b1720a33b65","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c3f5f81-4fda-4bc1-b22d-caa69df2cadd","type":"text/javascript","exec":[""]}}],"_postman_id":"89675daf-b4d6-4a91-93f3-2239b5037e6e"},{"name":"Workflow Steps","item":[{"name":"Retrieve All Steps","id":"d3ba2a39-6f84-4f93-979b-e61a15e473ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-steps","description":"

Returns a list of all workflow steps.

\n","urlObject":{"path":["workflow-steps"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"f998a9b3-37e1-4d08-853d-29b109d6ab12","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-steps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-steps\",\n \"id\": \"1\",\n \"attributes\": {\n \"text\": \"Start\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflow-steps/1\"\n },\n \"relationships\": {\n \"linkedState\": {\n \"data\": {\n \"id\": -1,\n \"type\": \"record-states\"\n }\n },\n \"workflowHistory\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"workflow-histories\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflow-steps?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/workflow-steps?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/workflow-steps?page=21\"\n }\n },\n \"meta\": {\n \"totalCount\": 418,\n \"pageCount\": 21,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"d3ba2a39-6f84-4f93-979b-e61a15e473ca"},{"name":"Retrieve Step","id":"0d72e78b-fe69-499a-a04e-99c709d758e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-steps/{{workflow_step_id}}","description":"

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`workflow_step_id`	Required The assigned ID for the workflow step, this can be found by performing a GET `{{endpoint}}/workflow-steps` request.

","urlObject":{"path":["workflow-steps","{{workflow_step_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"c5a37eec-698a-4e55-93b5-32583dffa70b","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-steps/{{workflow_step_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"workflow-steps\",\"id\":\"1\",\"attributes\":{\"text\":\"Start\"},\"links\":{\"self\":\"/backend/v1/workflow-steps/1\"},\"relationships\":{\"linkedState\":{\"data\":{\"id\":-1,\"type\":\"record-states\"}},\"workflowHistory\":{\"data\":{\"id\":1,\"type\":\"workflow-histories\"}}}}}"}],"_postman_id":"0d72e78b-fe69-499a-a04e-99c709d758e2"}],"id":"537d5b6a-0651-4c18-b53a-2d281ef190f4","description":"

Workflow steps are the series of steps that indicates the transitions' start point and end point.

\n","event":[{"listen":"prerequest","script":{"id":"cc66e596-37ec-435b-8903-52ee0b582c49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"35ba6e40-a713-4475-831d-fd9f4f948584","type":"text/javascript","exec":[""]}}],"_postman_id":"537d5b6a-0651-4c18-b53a-2d281ef190f4"},{"name":"Workflow Transitions","item":[{"name":"Retrieve All Transitions","id":"5cd4e640-475b-40d9-bb54-9cebb3af0bef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-transitions","description":"

Returns a list of all workflow transitions.

\n","urlObject":{"path":["workflow-transitions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"5a9b27d2-7b20-4921-9727-ae15a2c52e67","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-transitions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"workflow-transitions\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Create\",\n \"description\": \"This is the initial transition in the workflow\"\n },\n \"links\": {\n \"self\": \"/backend/v1/workflow-transitions/1\"\n },\n \"relationships\": {\n \"sourceStep\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"workflow-steps\"\n }\n },\n \"destinationStep\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"workflow-steps\"\n }\n },\n \"view\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"forms\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v1/workflow-transitions?page=1\"\n },\n \"next\": {\n \"href\": \"/backend/v1/workflow-transitions?page=2\"\n },\n \"last\": {\n \"href\": \"/backend/v1/workflow-transitions?page=43\"\n }\n },\n \"meta\": {\n \"totalCount\": 853,\n \"pageCount\": 43,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"5cd4e640-475b-40d9-bb54-9cebb3af0bef"},{"name":"Retrieve Transition","id":"dc8b03c1-24c7-48e9-99bd-a30bb2a25648","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-transitions/{{workflow_transition_id}}","description":"

Return details for a given workflow transition.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`workflow_transition_id`	Required The assigned ID for the workflow transition, this can be found by performing a GET `{{endpoint}}/workflow-transitions` request.

","urlObject":{"path":["workflow-transitions","{{workflow_transition_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"44a0af61-4fee-49db-9716-6f6771fbe195","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/workflow-transitions/{{workflow_transition_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","httpOnly":false,"domain":"localhost","path":"/","secure":false,"value":"9rapb8qaojqvnobase5vabc965","key":"PHPSESSID"}],"responseTime":null,"body":"{\"data\":{\"type\":\"workflow-transitions\",\"id\":\"1\",\"attributes\":{\"name\":\"Create\",\"description\":\"This is the initial transition in the workflow\"},\"links\":{\"self\":\"/backend/v1/workflow-transitions/1\"},\"relationships\":{\"sourceStep\":{\"data\":{\"id\":1,\"type\":\"workflow-steps\"}},\"destinationStep\":{\"data\":{\"id\":2,\"type\":\"workflow-steps\"}},\"view\":{\"data\":{\"id\":1,\"type\":\"forms\"}}}}}"}],"_postman_id":"dc8b03c1-24c7-48e9-99bd-a30bb2a25648"}],"id":"17b33f46-3eed-4ceb-b0dc-acf5d27c13d3","description":"

A workflow transition is the process for creating, configuring, training, etc. of any business function.

\n","event":[{"listen":"prerequest","script":{"id":"f51bcf1e-1442-4023-aa3c-b2f90b55db8c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e308e2c6-bfc1-4241-97e2-1c49e8db4102","type":"text/javascript","exec":[""]}}],"_postman_id":"17b33f46-3eed-4ceb-b0dc-acf5d27c13d3"},{"name":"ACE EBR™","item":[{"name":"Batch Plans","item":[{"name":"Retrieve All Versions of a Batch Plan Record","id":"c0d3808b-e689-4485-9cea-07452fda876d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions","description":"

Returns a list of all versions for a batch plan record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET {{endpoint}}/records request.

Response Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`status`	Indicates the version state: `0` – Draft `1` – Latest published `2` – Previously published

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"aa22757a-7ba1-44ac-b7c2-3e203a561093","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Authorization}}","disabled":true},{"key":"Content-Type","value":"application/json"},{"key":"Ace-Auth-Token","value":"{{SuperAuthorization}}","type":"text","disabled":true},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-plan-versions\",\n \"id\": \"152\",\n \"attributes\": {\n \"version\": 2,\n \"status\": 0,\n \"timestamp\": \"2024-04-02T17:24:48+00:00\",\n \"date_effective\": \"2024-04-02T17:24:48+00:00\"\n },\n \"relationships\": {\n \"record\": {\n \"data\": {\n \"id\": 6107,\n \"type\": \"records\"\n }\n }\n }\n },\n {\n \"type\": \"batch-plan-versions\",\n \"id\": \"151\",\n \"attributes\": {\n \"version\": 1,\n \"status\": 1,\n \"timestamp\": \"2024-04-02T17:24:48+00:00\",\n \"date_effective\": \"2024-04-02T17:24:48+00:00\"\n },\n \"relationships\": {\n \"record\": {\n \"data\": {\n \"id\": 6107,\n \"type\": \"records\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"c0d3808b-e689-4485-9cea-07452fda876d"},{"name":"Retrieve All Batch Steps","id":"9d9ebc18-c492-4e83-a433-33a752cecc40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-steps","description":"

Returns a list of batch step details for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","batch-steps"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d2332270-8111-410a-8e77-5edc35358a3f","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-steps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-steps\",\n \"id\": \"755\",\n \"attributes\": {\n \"section_id\": 326,\n \"group_id\": null,\n \"position\": 0,\n \"timestamp\": \"2024-04-02T17:24:48+00:00\"\n },\n \"relationships\": {\n \"section\": {\n \"data\": {\n \"id\": 326,\n \"type\": \"batch-object-section-datas\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-steps?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-steps?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-steps?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"9d9ebc18-c492-4e83-a433-33a752cecc40"},{"name":"Retrieve All Batch Step Sections","id":"752c6f53-2616-41f4-9cc5-f49f17393ffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/sections","description":"

Returns a list of batch step section details for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","sections"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"f83a2e67-61b1-4345-8e8c-7aed60f9282a","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/sections"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-object-section-datas\",\n \"id\": \"326\",\n \"attributes\": {\n \"section\": 1,\n \"section_title\": \"Overview\",\n \"section_desc\": \"\",\n \"sub_section\": null,\n \"sub_section_title\": null,\n \"sub_section_desc\": null,\n \"heading\": null,\n \"heading_title\": null,\n \"heading_desc\": null\n },\n \"relationships\": {\n \"version\": {\n \"data\": {\n \"id\": 152,\n \"type\": \"batch-plan-versions\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/sections?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/sections?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/sections?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"752c6f53-2616-41f4-9cc5-f49f17393ffb"},{"name":"Retrieve All Grouped Batch Steps","id":"7c0c5900-3e1c-4024-b2d2-dad302c52ee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/grouped-batch-steps","description":"

Returns a list of grouped batch step section details for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","grouped-batch-steps"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"dc1b9710-a87d-47cc-89c1-dbaf355463d4","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/grouped-batch-steps"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-object-group-datas\",\n \"id\": \"289\",\n \"attributes\": {\n \"group_title\": \"Operations\",\n \"group_signature\": [\n -8\n ]\n },\n \"relationships\": {\n \"version\": {\n \"data\": {\n \"id\": 152,\n \"type\": \"batch-plan-versions\"\n }\n },\n \"groupSignature\": {\n \"data\": {\n \"id\": [\n \"-8\"\n ],\n \"type\": \"custom-fields\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/grouped-batch-steps?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/grouped-batch-steps?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/grouped-batch-steps?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"7c0c5900-3e1c-4024-b2d2-dad302c52ee3"},{"name":"Retrieve All Batch Step Objects","id":"7e3623dc-ebff-44fa-bc43-bb299b932003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-step-objects","description":"

Returns a list of batch step objects for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","batch-step-objects"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"f576b446-6973-48ef-8251-798e16926446","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-step-objects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-objects\",\n \"id\": \"755\",\n \"attributes\": {\n \"object_id\": 80\n },\n \"relationships\": {\n \"batchStep\": {\n \"data\": {\n \"id\": 755,\n \"type\": \"batch-steps\"\n }\n },\n \"object\": {\n \"data\": {\n \"id\": 80,\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"batch-step-objects\",\n \"id\": \"4358\",\n \"attributes\": {\n \"object_id\": 82\n },\n \"relationships\": {\n \"batchStep\": {\n \"data\": {\n \"id\": 4358,\n \"type\": \"batch-steps\"\n }\n },\n \"object\": {\n \"data\": {\n \"id\": 82,\n \"type\": \"objects\"\n }\n }\n }\n },\n {\n \"type\": \"batch-step-objects\",\n \"id\": \"4359\",\n \"attributes\": {\n \"object_id\": 83\n },\n \"relationships\": {\n \"batchStep\": {\n \"data\": {\n \"id\": 4359,\n \"type\": \"batch-steps\"\n }\n },\n \"object\": {\n \"data\": {\n \"id\": 83,\n \"type\": \"objects\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-step-objects?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-step-objects?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-step-objects?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"7e3623dc-ebff-44fa-bc43-bb299b932003"},{"name":"Retrieve All Batch Step Object Fields","id":"ac0a00b1-8270-4db1-98d7-8b02fff715d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-step-objects/{{batch_step_id}}/meta","description":"

Returns a list of batch step object fields for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.
`batch_step_id`	Required The assigned ID for the batch step can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-steps` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","batch-step-objects","{{batch_step_id}}","meta"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"9b7f1646-ab01-4497-a6d4-82d454739d84","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-step-objects/{{batch_step_id}}/meta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"object-records\",\n \"id\": \"755\",\n \"attributes\": {\n \"name\": \"af771316-e239-4fbb-a6e2-7003a2c5f71d\",\n \"cf_actual_risk_rating\": \"Low\",\n \"cf_a_text_field\": \"To Do\"\n },\n \"meta\": {\n \"cf_actual_risk_rating\": {\n \"type\": \"custom-fields\",\n \"id\": \"-414\",\n \"attributes\": {\n \"fieldType\": \"select\",\n \"label\": \"Actual Risk Rating\"\n }\n },\n \"cf_a_text_field\": {\n \"type\": \"custom-fields\",\n \"id\": \"398\",\n \"attributes\": {\n \"fieldType\": \"textfield\",\n \"label\": \"A Text Field\"\n }\n }\n }\n }\n}"}],"_postman_id":"ac0a00b1-8270-4db1-98d7-8b02fff715d2"},{"name":"Retrieve All Batch Step Execution Objects","id":"39d73aa1-7a45-4888-a9f7-006fc32f555f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-step-execution-objects","description":"

Returns a list of batch step execution objects for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","batch-step-execution-objects"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"bd698682-8dc1-4aad-8c3d-23a6125cfdc2","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/batch-step-execution-objects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-execution-record-objects\",\n \"id\": \"755\",\n \"attributes\": {\n \"object_id\": 81\n },\n \"relationships\": {\n \"batchStep\": {\n \"data\": {\n \"id\": 755,\n \"type\": \"batch-steps\"\n }\n },\n \"object\": {\n \"data\": {\n \"id\": 81,\n \"type\": \"objects\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-step-execution-objects?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-step-execution-objects?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/batch-step-execution-objects?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"39d73aa1-7a45-4888-a9f7-006fc32f555f"},{"name":"Retrieve All Batch Step Signature Fields","id":"3c8b8e49-bd23-4171-a8e7-b5e914a59363","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/signatures","description":"

Returns a list of batch step signature fields for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.
`version_id`	Required The assigned ID for the version can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-plan-versions` request.

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","signatures"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"0b109f20-bafa-48de-809a-6651c3626f63","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/signatures"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-signatures\",\n \"id\": \"3906\",\n \"attributes\": {\n \"record_id\": 755,\n \"signature\": [\n -7\n ]\n },\n \"relationships\": {\n \"record\": {\n \"data\": {\n \"id\": 755,\n \"type\": \"batch-steps\"\n }\n },\n \"signature\": {\n \"data\": {\n \"id\": [\n \"-7\"\n ],\n \"type\": \"custom-fields\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/signatures?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/signatures?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/signatures?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"3c8b8e49-bd23-4171-a8e7-b5e914a59363"},{"name":"Retrieve All Batch Step Conditions","id":"6d095c8c-a89f-4c29-b827-a232266cd105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/conditions","description":"

Returns a list of batch step condition details for a given batch plan version record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET {{endpoint}}/records request.
`version_id`	Required The assigned ID for the version can be found by performing a GET {{endpoint}}/records/{{record_id}}/batch-plan-versions request.

Response Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`condition_result_type`	Defines the result when a condition is not met: `0` – No action needed `1` – Pause step for signature `2` – Halt batch for signature
`operator_type`	Specifies the comparison operator: `0` – Less than `1` – Less than or equal to `2` – Equal to `3` – Greater than `4` – Greater than or equal to

","urlObject":{"path":["records","{{record_id}}","batch-plan-versions","{{version_id}}","conditions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"53645c66-72e0-4080-b68f-5d3bedeaf690","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-plan-versions/{{version_id}}/conditions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-conditions\",\n \"id\": \"817\",\n \"attributes\": {\n \"parent_id\": null,\n \"custom_field_id\": -445,\n \"unit_value\": \"Low\",\n \"operator_type\": 2,\n \"condition_result_type\": 0,\n \"batch_step_id\": 755\n },\n \"relationships\": {\n \"batchStep\": {\n \"data\": {\n \"id\": 755,\n \"type\": \"batch-steps\"\n }\n },\n \"customField\": {\n \"data\": {\n \"id\": -445,\n \"type\": \"custom-fields\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/conditions?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/conditions?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-plan-versions/152/conditions?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"6d095c8c-a89f-4c29-b827-a232266cd105"},{"name":"Retrieve All Executions of a Batch Plan Record","id":"1105c8f7-b732-47d5-bd3c-7dc2b14db966","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-executions","description":"

Returns a list of batch executions for a batch plan record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch plan record can be found by performing a GET `{{endpoint}}/records` request.

","urlObject":{"path":["records","{{record_id}}","batch-executions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"7daa4058-7625-4ec1-a421-9717448a3eaa","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-executions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-execution-records\",\n \"id\": \"6110\",\n \"attributes\": {\n \"pkey\": \"NEE-131\",\n \"date_created\": \"2024-04-02T19:05:58+00:00\",\n \"date_updated\": \"2024-04-02T19:05:58+00:00\",\n \"parent_id\": 6107\n },\n \"links\": {\n \"self\": \"/backend/v3/records/6110\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 6107,\n \"type\": \"batch-plan-records\"\n }\n }\n }\n },\n {\n \"type\": \"batch-execution-records\",\n \"id\": \"6108\",\n \"attributes\": {\n \"pkey\": \"NEE-129\",\n \"date_created\": \"2024-04-02T17:25:05+00:00\",\n \"date_updated\": \"2024-04-02T17:25:05+00:00\",\n \"parent_id\": 6107\n },\n \"links\": {\n \"self\": \"/backend/v3/records/6108\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 6107,\n \"type\": \"batch-plan-records\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/6107/batch-executions?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/6107/batch-executions?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/6107/batch-executions?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 2,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"1105c8f7-b732-47d5-bd3c-7dc2b14db966"},{"name":"Retrieve Batch Execution Record Metadata","id":"ffdbc576-ec45-4a48-be1d-afd0991d45ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-execution-meta","description":"

Returns the values of all system and custom fields for a given batch execution record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch execution record can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-executions` request.

","urlObject":{"path":["records","{{record_id}}","batch-execution-meta"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"3a7f3b2a-9ce4-4b88-bc71-d87d29596fd1","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-execution-meta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"batch-execution-records\",\n \"id\": \"6110\",\n \"attributes\": {\n \"pkey\": \"NEE-131\",\n \"date_created\": \"2024-04-02T19:05:58+00:00\",\n \"date_updated\": \"2024-04-02T19:05:58+00:00\",\n \"parent_id\": 6107,\n \"reviewers\": [\n 20,\n 16,\n 18\n ],\n \"test_case_version_picker\": [\n 151\n ],\n \"execution_status\": \"Passed\"\n },\n \"meta\": {\n \"reviewers\": {\n \"type\": \"custom-fields\",\n \"id\": \"-8\",\n \"attributes\": {\n \"fieldType\": \"multiPicker\",\n \"label\": \"Reviewers\"\n }\n }\n },\n \"links\": {\n \"self\": \"/backend/v3/records/6110\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 6107,\n \"type\": \"batch-plan-records\"\n }\n },\n \"version\": {\n \"data\": {\n \"id\": [\n \"151\"\n ],\n \"type\": \"batch-plan-versions\"\n }\n }\n }\n }\n}"}],"_postman_id":"ffdbc576-ec45-4a48-be1d-afd0991d45ba"}],"id":"60977a6d-2cc0-4497-af25-a72ef944ff63","description":"

Batch Plans break down data into batch steps, controlling how event data is grouped and handled in EBR.

\n","_postman_id":"60977a6d-2cc0-4497-af25-a72ef944ff63"},{"name":"Batch Executions","item":[{"name":"Retrieve Summary Fields of a Batch Execution","id":"ab162d13-d2ef-4fad-97c3-7a737aaef909","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-execution-summary","description":"

Returns a list of summary fields configured for a batch execution record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch execution record can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-executions` request.

","urlObject":{"path":["records","{{record_id}}","batch-execution-summary"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"ceafaf19-99c6-4e03-954b-3c6626fd6e61","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-execution-summary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"ebr-batch-summaries\",\n \"id\": \"1\",\n \"attributes\": {\n \"project_id\": 100,\n \"planFields\": [\n \"pkey\",\n \"cf_text_area\"\n ],\n \"executionFields\": [\n \"cf_describe_disposition_exe\",\n \"cf_text_area\",\n \"assigned_to\",\n \"cf_multi_group_picker\"\n ]\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n }\n }\n }\n}"}],"_postman_id":"ab162d13-d2ef-4fad-97c3-7a737aaef909"},{"name":"Retrieve All Step Execution Records of a Batch Execution","id":"6a5e07e6-34b8-40a0-abff-fa3b337f17c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-step-executions","description":"

Returns a list of batch step executions for a batch execution record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch execution record can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-executions` request.

","urlObject":{"path":["records","{{record_id}}","batch-step-executions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"963ecc13-46df-43d1-bac4-1a25b95e91d5","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-step-executions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-execution-records\",\n \"id\": \"17067\",\n \"attributes\": {\n \"pkey\": \"NEE-9879\",\n \"date_created\": \"2025-08-13T19:00:00+00:00\",\n \"date_updated\": \"2025-08-13T19:00:00+00:00\",\n \"link_id\": 755,\n \"parent_id\": 17066\n },\n \"links\": {\n \"self\": \"/backend/v3/records/17067\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 17066,\n \"type\": \"batch-execution-records\"\n }\n },\n \"link\": {\n \"data\": {\n \"id\": 755,\n \"type\": \"batch-steps\"\n }\n }\n }\n },\n {\n \"type\": \"batch-step-execution-records\",\n \"id\": \"17068\",\n \"attributes\": {\n \"pkey\": \"NEE-9880\",\n \"date_created\": \"2025-08-13T19:00:00+00:00\",\n \"date_updated\": \"2025-08-13T19:00:00+00:00\",\n \"link_id\": 4358,\n \"parent_id\": 17066\n },\n \"links\": {\n \"self\": \"/backend/v3/records/17068\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 17066,\n \"type\": \"batch-execution-records\"\n }\n },\n \"link\": {\n \"data\": {\n \"id\": 4358,\n \"type\": \"batch-steps\"\n }\n }\n }\n },\n {\n \"type\": \"batch-step-execution-records\",\n \"id\": \"17069\",\n \"attributes\": {\n \"pkey\": \"NEE-9881\",\n \"date_created\": \"2025-08-13T19:00:00+00:00\",\n \"date_updated\": \"2025-08-13T19:00:00+00:00\",\n \"link_id\": 4359,\n \"parent_id\": 17066\n },\n \"links\": {\n \"self\": \"/backend/v3/records/17069\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 17066,\n \"type\": \"batch-execution-records\"\n }\n },\n \"link\": {\n \"data\": {\n \"id\": 4359,\n \"type\": \"batch-steps\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/17066/batch-step-executions?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/17066/batch-step-executions?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/17066/batch-step-executions?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"6a5e07e6-34b8-40a0-abff-fa3b337f17c5"},{"name":"Retrieve Batch Step Execution Record Metadata","id":"a7d060f3-3d54-45ad-bfb2-d8ffac9ada66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-step-execution-meta","description":"

Returns the values of all system and custom fields for a given batch step execution record.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch step execution record can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-step-executions` request.

","urlObject":{"path":["records","{{record_id}}","batch-step-execution-meta"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"4132e9da-2954-4733-a220-d5c9ba641e70","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-step-execution-meta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"batch-step-execution-records\",\n \"id\": \"17067\",\n \"attributes\": {\n \"pkey\": \"NEE-9879\",\n \"date_created\": \"2025-08-13T19:00:00+00:00\",\n \"date_updated\": \"2025-08-13T19:04:02+00:00\",\n \"link_id\": 755,\n \"parent_id\": 17066,\n \"cf_amount_of_material_aff\": \"23\",\n \"cf_business_risk_severity\": \"High\",\n \"cf_business_risk_probability\": \"Low\",\n \"batch_flag\": null,\n \"batch_edit\": null\n },\n \"meta\": {\n \"cf_amount_of_material_aff\": {\n \"type\": \"custom-fields\",\n \"id\": \"-471\",\n \"attributes\": {\n \"fieldType\": \"textfield\",\n \"label\": \"Amount of Material Affected\"\n }\n },\n \"cf_business_risk_severity\": {\n \"type\": \"custom-fields\",\n \"id\": \"-446\",\n \"attributes\": {\n \"fieldType\": \"select\",\n \"label\": \"Business Risk Severity\"\n }\n },\n \"cf_business_risk_probability\": {\n \"type\": \"custom-fields\",\n \"id\": \"-445\",\n \"attributes\": {\n \"fieldType\": \"select\",\n \"label\": \"Business Risk Probability\"\n }\n },\n \"batch_flag\": {\n \"type\": \"custom-fields\",\n \"id\": \"725\",\n \"attributes\": {\n \"fieldType\": \"textarea\",\n \"label\": \"Flagged Step\"\n }\n },\n \"batch_edit\": {\n \"type\": \"custom-fields\",\n \"id\": \"726\",\n \"attributes\": {\n \"fieldType\": \"textarea\",\n \"label\": \"Edited Step\"\n }\n }\n },\n \"links\": {\n \"self\": \"/backend/v3/records/17067\"\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 100,\n \"type\": \"projects\"\n }\n },\n \"parent\": {\n \"data\": {\n \"id\": 17066,\n \"type\": \"batch-execution-records\"\n }\n },\n \"link\": {\n \"data\": {\n \"id\": 755,\n \"type\": \"batch-steps\"\n }\n }\n }\n }\n}"}],"_postman_id":"a7d060f3-3d54-45ad-bfb2-d8ffac9ada66"},{"name":"Retrieve All Batch Step Execution Statuses of a Batch Execution","id":"3fa48063-d59c-41c6-a7e0-04a980c8f17e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-step-execution-status","description":"

Returns a list of batch step execution statuses for a batch execution.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch execution record can be found by performing a GET `{{endpoint}}/records/{{record_id}}/batch-executions` request.

","urlObject":{"path":["records","{{record_id}}","batch-step-execution-status"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"25774985-13d3-45dd-b33c-8e7faad6f7e1","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-step-execution-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-execution-statuses\",\n \"id\": \"17067\",\n \"attributes\": {\n \"name\": \"test_step_state\",\n \"value\": -1\n },\n \"relationships\": {\n \"record\": {\n \"data\": {\n \"id\": 17067,\n \"type\": \"batch-step-execution-records\"\n }\n }\n }\n },\n {\n \"type\": \"batch-step-execution-statuses\",\n \"id\": \"17068\",\n \"attributes\": {\n \"name\": \"test_step_state\",\n \"value\": -1\n },\n \"relationships\": {\n \"record\": {\n \"data\": {\n \"id\": 17068,\n \"type\": \"batch-step-execution-records\"\n }\n }\n }\n },\n {\n \"type\": \"batch-step-execution-statuses\",\n \"id\": \"17069\",\n \"attributes\": {\n \"name\": \"test_step_state\",\n \"value\": -1\n },\n \"relationships\": {\n \"record\": {\n \"data\": {\n \"id\": 17069,\n \"type\": \"batch-step-execution-records\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/17066/batch-step-execution-status?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/17066/batch-step-execution-status?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/17066/batch-step-execution-status?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"3fa48063-d59c-41c6-a7e0-04a980c8f17e"},{"name":"Retrieve All Step Execution Signatures of a Batch Execution","id":"955dbb34-73ce-484b-ad44-b8ea9c5c602a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/records/{{record_id}}/batch-step-execution-signatures","description":"

Returns a list of batch step execution signatures for a batch execution.

URI Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
`record_id`	Required The assigned ID for the batch execution record can be found by performing a GET `{{endpoint_v3}}/records/{{record_id}}/batch-executions` request.

","urlObject":{"path":["records","{{record_id}}","batch-step-execution-signatures"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"07ea458c-4720-477d-8023-2e7131fb9cd5","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint_v3}}/records/{{record_id}}/batch-step-execution-signatures"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"batch-step-execution-signatures\",\n \"id\": \"237\",\n \"attributes\": {\n \"record_id\": 17067,\n \"user_id\": 18,\n \"field_id\": -7,\n \"decision\": 1,\n \"reason\": null,\n \"timestamp\": \"2025-08-13T19:09:23+00:00\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": 18,\n \"type\": \"users\"\n }\n },\n \"record\": {\n \"data\": {\n \"id\": 17067,\n \"type\": \"batch-step-execution-records\"\n }\n },\n \"field\": {\n \"data\": {\n \"id\": -7,\n \"type\": \"custom-fields\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"self\": {\n \"href\": \"/backend/v3/records/17066/batch-step-execution-signatures?page=1\"\n },\n \"first\": {\n \"href\": \"/backend/v3/records/17066/batch-step-execution-signatures?page=1\"\n },\n \"last\": {\n \"href\": \"/backend/v3/records/17066/batch-step-execution-signatures?page=1\"\n }\n },\n \"meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"955dbb34-73ce-484b-ad44-b8ea9c5c602a"}],"id":"23a14906-59a0-4728-b5fa-41d634b4dbee","description":"

Batch Executions run the processing of grouped data according to batch plans.

\n","_postman_id":"23a14906-59a0-4728-b5fa-41d634b4dbee"}],"id":"56db461a-190e-4d9c-9b67-883d2a6e9aa8","description":"

ACE EBR™ is a digital system that records and manages manufacturing batch data to ensure compliance and traceability.

⚠️ Note: This endpoint is only supported in v3 of the API and requires ACE® version 2024.3.x or later.

\n","_postman_id":"56db461a-190e-4d9c-9b67-883d2a6e9aa8"},{"name":"ACE LMS","item":[{"name":"Curriculum","item":[{"name":"Retrieve All Courses of a Curriculum Record (View Record permission)","id":"e75f87de-4b3b-40aa-aed1-7f6ad6969df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{curriculum_record_id}}/curriculum/courses","description":"

Endpoint Description

This endpoint retrieves a list of courses associated with a specific curriculum record identified by curriculum_record_id. The response includes detailed information about each course, including its attributes and relationships.

Request Parameters

curriculum_record_id (path parameter): The unique identifier for the curriculum record whose associated courses are being fetched.

Expected Response

The response is a JSON object containing the following structure:

data: An array of course objects, each containing:
\n
- type: The type of the course (string).
  \n
- id: The unique identifier for the course (string).
  \n
- attributes: An object containing course details:
  \n
  - description: A brief description of the course (string).
    \n
  - title: The title of the course (string).
    \n
  - module: The module to which the course belongs (string).
    \n
  - date_created: The timestamp when the course was created (string).
    \n
  - date_updated: The timestamp when the course was last updated (string).
    \n
  - pkey: A primary key identifier (string).
    \n
  - doc_version: The document version of the course (string).
    \n
  - course_version: The version of the course (string).
    \n
  - link_id: An optional link identifier (nullable).
    \n
  \n
- links: An object containing:
  \n
  - self: A link to the course resource (string).
  \n
- relationships: An object detailing the relationships of the course:
  \n
  - initiator: An object containing the initiator's data:
    \n
    - id: The identifier of the initiator (integer).
      \n
    - type: The type of the initiator (string).
      \n
    \n
  - project: An object containing the project's data:
    \n
    - id: The identifier of the project (integer).
      \n
    - type: The type of the project (string).
      \n
    \n
  - type: An object containing the type's data:
    \n
    - id: The identifier of the type (integer).
      \n
    - type: The type (string).
      \n
    \n
  - status: An object containing the status's data:
    \n
    - id: The identifier of the status (integer).
      \n
    - type: The type of the status (string).
      \n
    \n
  \n
\n
links: An object containing pagination links:
\n
- self: A link to the current resource (string).
  \n
- first: A link to the first page of results (string).
  \n
- last: A link to the last page of results (string).
  \n
\n
meta: An object containing pagination metadata:
\n
- totalCount: The total number of courses available (integer).
  \n
- pageCount: The total number of pages available (integer).
  \n
- currentPage: The current page number (integer).
  \n
- perPage: The number of items per page (integer).
  \n
\n

JSON Schema for the Response

{\n  \"data\": [\n    {\n      \"type\": \"string\",\n      \"id\": \"string\",\n      \"attributes\": {\n        \"description\": \"string\",\n        \"title\": \"string\",\n        \"module\": \"string\",\n        \"date_created\": \"string\",\n        \"date_updated\": \"string\",\n        \"pkey\": \"string\",\n        \"doc_version\": \"string\",\n        \"course_version\": \"string\",\n        \"link_id\": \"nullable\"\n      },\n      \"links\": {\n        \"self\": \"string\"\n      },\n      \"relationships\": {\n        \"initiator\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        },\n        \"project\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        },\n        \"type\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        },\n        \"status\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": \"string\",\n    \"first\": \"string\",\n    \"last\": \"string\"\n  },\n  \"meta\": {\n    \"totalCount\": \"integer\",\n    \"pageCount\": \"integer\",\n    \"currentPage\": \"integer\",\n    \"perPage\": \"integer\"\n  }\n}\n\n

This endpoint retrieves a list of courses associated with a specific curriculum record identified by curriculum_record_id.

Request Parameters

curriculum_record_id (path parameter): The unique identifier for the curriculum record whose courses are being requested.

Response

On a successful request, the API returns a 200 OK status with a JSON payload containing the following structure:

data: An array of course objects, each containing:
\n
- type: The type of the resource (string).
  \n
- id: The unique identifier of the course (string).
  \n
- attributes: An object containing:
  \n
  - description: A brief description of the course (string).
    \n
  - title: The title of the course (string).
    \n
  - module: The module information related to the course (string).
    \n
  - date_created: The date the course was created (string).
    \n
  - date_updated: The date the course was last updated (string).
    \n
  - pkey: A primary key for the course (string).
    \n
  - doc_version: The document version (string).
    \n
  - course_version: The version of the course (string).
    \n
  - link_id: An optional link identifier (nullable).
    \n
  \n
- links: An object containing:
  \n
  - self: A self-referential link to the course (string).
  \n
- relationships: An object defining relationships to other resources, including:
  \n
  - initiator: The entity that initiated the course (object with id and type).
    \n
  - project: The project associated with the course (object with id and type).
    \n
  - type: The type of course (object with id and type).
    \n
  - status: The current status of the course (object with id and type).
    \n
  \n
\n
links: Pagination links:
\n
- self: A link to the current page of results (string).
  \n
- first: A link to the first page of results (string).
  \n
- last: A link to the last page of results (string).
  \n
\n
meta: Metadata about the response, including:
\n
- totalCount: The total number of courses available (integer).
  \n
- pageCount: The total number of pages available (integer).
  \n
- currentPage: The current page number (integer).
  \n
- perPage: The number of items per page (integer).
  \n
\n

Notes

Ensure that the curriculum_record_id is valid to receive the expected results.
\n
The response may contain an empty data array if no courses are associated with the specified curriculum record.
\n

\n","urlObject":{"path":["records","{{curriculum_record_id}}","curriculum","courses"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e75f87de-4b3b-40aa-aed1-7f6ad6969df4"},{"name":"Retrieve All Roles of a Curriculum Record (View Record permission)","id":"65d3fc90-6b7e-4157-ad14-df7d2451fa49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{curriculum_record_id}}/curriculum/roles","description":"

Endpoint Description

This endpoint retrieves the roles associated with a specific curriculum record identified by curriculum_record_id. It is a GET request that returns a list of roles along with pagination information.

Request Parameters

curriculum_record_id (path parameter): The unique identifier for the curriculum record whose roles are being requested.

Response Structure

The response is returned in JSON format and contains the following structure:

data (array): An array of role objects, each containing:
\n
- type (string): The type of the role.
  \n
- id (string): The unique identifier for the role.
  \n
- attributes (object): An object containing:
  \n
  - name (string): The name of the role.
    \n
  - desc (string): A description of the role.
    \n
  \n
- links (object): An object containing:
  \n
  - self (string): A link to the specific role resource.
  \n
\n
links (object): Contains pagination links:
\n
- self (object): A link to the current resource.
  \n
- first (object): A link to the first page of results.
  \n
- last (object): A link to the last page of results.
  \n
\n
meta (object): Contains metadata about the response:
\n
- totalCount (integer): The total number of roles available.
  \n
- pageCount (integer): The number of pages of results.
  \n
- currentPage (integer): The current page number.
  \n
- perPage (integer): The number of results per page.
  \n
\n

Example Response

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"name\": \"\",\n        \"desc\": \"\"\n      },\n      \"links\": {\n        \"self\": \"\"\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

This structure allows clients to understand the roles associated with a curriculum record and navigate through the available data efficiently.

This endpoint retrieves the roles associated with a specific curriculum record identified by curriculum_record_id. It is designed to provide a list of roles along with their attributes and pagination links.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{curriculum_record_id}}/curriculum/roles
\n

Path Parameters

curriculum_record_id: The unique identifier for the curriculum record whose roles are being requested.

Response

The response is returned in JSON format and contains the following structure:

data: An array of role objects, each containing:
\n
- type: The type of the role (string).
  \n
- id: The unique identifier for the role (string).
  \n
- attributes: An object containing:
  \n
  - name: The name of the role (string).
    \n
  - desc: A description of the role (string).
    \n
  \n
- links: An object containing:
  \n
  - self: A link to the specific role (string).
  \n
\n
links: An object providing pagination information, including:
\n
- self: A link to the current request (string).
  \n
- first: A link to the first page of results (string).
  \n
- last: A link to the last page of results (string).
  \n
\n
meta: An object containing metadata about the response:
\n
- totalCount: The total number of roles available (integer).
  \n
- pageCount: The total number of pages available (integer).
  \n
- currentPage: The current page number (integer).
  \n
- perPage: The number of items per page (integer).
  \n
\n

Example Response

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"name\": \"\",\n        \"desc\": \"\"\n      },\n      \"links\": {\n        \"self\": \"\"\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

This endpoint is crucial for applications needing to display or manage roles associated with curriculum records, providing essential data in a structured format.

\n","urlObject":{"path":["records","{{curriculum_record_id}}","curriculum","roles"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65d3fc90-6b7e-4157-ad14-df7d2451fa49"}],"id":"32969035-b00b-4587-8418-2375cca30215","_postman_id":"32969035-b00b-4587-8418-2375cca30215","description":""},{"name":"Course","item":[{"name":"Retrieve All Curriculums of a Course Record (View Record permission)","id":"4d3cc906-8b88-4b68-afb3-848ce2e5093d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/curriculums","description":"

Endpoint Description

This endpoint retrieves the curriculum details associated with a specific course record identified by record_id. The request is made using the HTTP GET method.

Request Parameters

record_id (path parameter): The unique identifier for the course record whose curriculums are being requested.

Expected Response

Upon a successful request, the server responds with a status code of 200 and returns a JSON object containing the curriculum details. The structure of the response includes the following key components:

data: An array of curriculum objects, each containing:
\n
- type: The type of the curriculum (string).
  \n
- id: The unique identifier of the curriculum (string).
  \n
- attributes: An object containing:
  \n
  - description: A brief description of the curriculum (nullable string).
    \n
  - title: The title of the curriculum (nullable string).
    \n
  - module: The module associated with the curriculum (string).
    \n
  - date_created: The date when the curriculum was created (string).
    \n
  - date_updated: The date when the curriculum was last updated (string).
    \n
  - pkey: The primary key of the curriculum (string).
    \n
  - doc_version: The document version (string).
    \n
  - course_version: The version of the course (string).
    \n
  - link_id: An optional link identifier (nullable string).
    \n
  \n
- links: An object containing:
  \n
  - self: A link to the curriculum resource (string).
  \n
- relationships: An object defining relationships with other resources:
  \n
  - initiator: An object containing the initiator's details.
    \n
  - project: An object containing the project details.
    \n
  - type: An object containing the type details.
    \n
  - status: An object containing the status details.
    \n
  \n
\n
links: An object containing pagination links:
\n
- self: A link to the current resource.
  \n
- first: A link to the first page of results.
  \n
- last: A link to the last page of results.
  \n
\n
meta: An object containing pagination metadata:
\n
- totalCount: The total number of curriculums available (integer).
  \n
- pageCount: The number of pages of results (integer).
  \n
- currentPage: The current page number (integer).
  \n
- perPage: The number of items per page (integer).
  \n
\n

JSON Schema for Response

{\n  \"data\": [\n    {\n      \"type\": \"string\",\n      \"id\": \"string\",\n      \"attributes\": {\n        \"description\": \"string|null\",\n        \"title\": \"string|null\",\n        \"module\": \"string\",\n        \"date_created\": \"string\",\n        \"date_updated\": \"string\",\n        \"pkey\": \"string\",\n        \"doc_version\": \"string\",\n        \"course_version\": \"string\",\n        \"link_id\": \"string|null\"\n      },\n      \"links\": {\n        \"self\": \"string\"\n      },\n      \"relationships\": {\n        \"initiator\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        },\n        \"project\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        },\n        \"type\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        },\n        \"status\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": \"string\",\n    \"first\": \"string\",\n    \"last\": \"string\"\n  },\n  \"meta\": {\n    \"totalCount\": \"integer\",\n    \"pageCount\": \"integer\",\n    \"currentPage\": \"integer\",\n    \"perPage\": \"integer\"\n  }\n}\n\n

This endpoint allows you to retrieve the curriculums associated with a specific course record.

Request Parameters

record_id (path parameter): The unique identifier for the course record whose curriculums you wish to access. This parameter is required.

Response

Upon a successful request, the response will include:

A list of curriculums related to the specified course record. Each curriculum object may contain details such as curriculum ID, title, description, and other relevant attributes.

Notes

Ensure that the record_id provided in the URL is valid and corresponds to an existing course record to avoid errors.
\n
The response will be in JSON format, and you should handle it accordingly in your application.
\n

\n","urlObject":{"path":["records","{{record_id}}","course","curriculums"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d3cc906-8b88-4b68-afb3-848ce2e5093d"},{"name":"Retrieve All Settings of a Course Record (View Record permission)","id":"d87a2caa-54c3-4aa8-97e9-1757486d865e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/configs","description":"

Endpoint Description

This endpoint retrieves the configuration settings for a specific course associated with a given record ID. It provides details such as sign-off requirements, notification settings, and other attributes related to the course configuration.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{record_id}}/course/configs
\n

Path Parameters

record_id (string): The unique identifier of the record for which course configurations are being requested.

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

Response Structure

The response contains a JSON object with the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"string\",\n      \"id\": \"string\",\n      \"attributes\": {\n        \"signoff\": \"integer\",\n        \"notify_complete\": \"integer\",\n        \"signoff_trainee\": \"integer\",\n        \"site\": \"integer\",\n        \"pass_percentage\": \"number or null\",\n        \"learning_category_id\": \"integer or null\",\n        \"grace_period\": \"integer\",\n        \"grace_period_type\": \"string\",\n        \"manager\": \"integer\",\n        \"add_grace_period\": \"integer\",\n        \"set_date_due\": \"integer\",\n        \"min_time_period\": \"integer\",\n        \"min_time_period_type\": \"string\",\n        \"retrain_from\": \"integer\",\n        \"retrain_from_date\": \"integer\",\n        \"repeat_every_value\": \"integer\",\n        \"repeat_every_type\": \"string\",\n        \"repeat_set\": \"integer\",\n        \"without_due_date\": \"integer\",\n        \"training_coordinator\": \"integer\",\n        \"initial_status\": \"integer\",\n        \"status_change_due_date\": \"integer\",\n        \"alt_grace_period\": \"number or null\",\n        \"alt_grace_period_type\": \"string or null\"\n      },\n      \"relationships\": {\n        \"record\": {\n          \"data\": {\n            \"id\": \"integer\",\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"string\"\n    },\n    \"first\": {\n      \"href\": \"string\"\n    },\n    \"last\": {\n      \"href\": \"string\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": \"integer\",\n    \"pageCount\": \"integer\",\n    \"currentPage\": \"integer\",\n    \"perPage\": \"integer\"\n  }\n}\n\n

JSON Schema for Response

The JSON schema for the response can be summarized as follows:

data: An array of configuration objects, each containing:
\n
- type: The type of the resource (string).
  \n
- id: The unique identifier for the configuration (string).
  \n
- attributes: An object containing various configuration attributes:
  \n
  - signoff: Indicates if signoff is required (integer).
    \n
  - notify_complete: Indicates if notifications are sent upon completion (integer).
    \n
  - signoff_trainee: Indicates if signoff is required from trainees (integer).
    \n
  - site: The site identifier (integer).
    \n
  - pass_percentage: The required pass percentage (number or null).
    \n
  - learning_category_id: The ID of the learning category (integer or null).
    \n
  - grace_period: The grace period duration (integer).
    \n
  - grace_period_type: The type of grace period (string).
    \n
  - Additional attributes related to training and status.
    \n
  \n
- relationships: An object that includes the relationship to the record:
  \n
  - record: Contains the ID and type of the related record.
  \n
\n
links: Contains pagination links for navigating through the results.
\n
meta: Provides metadata about the response, including total counts and pagination details.
\n

Note

Ensure that the record_id is valid to retrieve the appropriate course configurations.

This endpoint retrieves the configuration settings for a specific course associated with a given record ID. It provides detailed attributes related to course management, including sign-off requirements, notification settings, grace periods, and status tracking.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{record_id}}/course/configs
\n

Path Parameters

record_id (required): The unique identifier for the record whose course configurations are being requested.

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

Response Structure

The response contains a JSON object with the following structure:

data: An array of configuration objects for the course.
\n
- type: The type of the configuration (string).
  \n
- id: The unique identifier for the configuration (string).
  \n
- attributes: An object containing various configuration attributes:
  \n
  - signoff: Indicates if sign-off is required (integer).
    \n
  - notify_complete: Indicates if notifications should be sent upon completion (integer).
    \n
  - signoff_trainee: Indicates if trainee sign-off is required (integer).
    \n
  - site: The site identifier (integer).
    \n
  - pass_percentage: The percentage required to pass (nullable).
    \n
  - learning_category_id: The ID for the learning category (nullable).
    \n
  - grace_period: The grace period duration (integer).
    \n
  - grace_period_type: The type of grace period (string).
    \n
  - manager: Indicates if manager approval is required (integer).
    \n
  - add_grace_period: Indicates if an additional grace period can be added (integer).
    \n
  - set_date_due: Indicates if a due date should be set (integer).
    \n
  - min_time_period: The minimum time period required (integer).
    \n
  - min_time_period_type: The type of minimum time period (string).
    \n
  - retrain_from: Indicates if retraining is required (integer).
    \n
  - retrain_from_date: The date from which retraining starts (integer).
    \n
  - repeat_every_value: The value for repeat intervals (integer).
    \n
  - repeat_every_type: The type of repeat interval (string).
    \n
  - repeat_set: Indicates if a repeat is set (integer).
    \n
  - without_due_date: Indicates if there is no due date (integer).
    \n
  - training_coordinator: The ID of the training coordinator (integer).
    \n
  - initial_status: The initial status of the course (integer).
    \n
  - status_change_due_date: The due date for status changes (integer).
    \n
  - alt_grace_period: An alternative grace period (nullable).
    \n
  - alt_grace_period_type: The type of alternative grace period (nullable).
    \n
  \n
- relationships: An object defining relationships with other entities.
  \n
  - record: An object containing the ID and type of the related record.
  \n
\n
links: Pagination links for navigating through results.
\n
- self: Link to the current resource.
  \n
- first: Link to the first page of results.
  \n
- last: Link to the last page of results.
  \n
\n
meta: Metadata about the response.
\n
- totalCount: Total number of items available (integer).
  \n
- pageCount: Total number of pages (integer).
  \n
- currentPage: The current page number (integer).
  \n
- perPage: Number of items per page (integer).
  \n
\n

Notes

Ensure that the record_id provided is valid and corresponds to an existing record.
\n
The response may include multiple configurations depending on the course setup.
\n
Handle the nullable fields appropriately in your application logic.
\n

\n","urlObject":{"path":["records","{{record_id}}","course","configs"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d87a2caa-54c3-4aa8-97e9-1757486d865e"},{"name":"Retrieve All Prerequisites of a Course Record (View Record permission)","id":"45ba67a2-7ae1-46b8-98fc-d2705e1d89f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/prerequisites","description":"

Get Course Prerequisites

This endpoint retrieves the prerequisites for a specific course associated with a given record ID. It is useful for understanding what prior knowledge or courses are required before enrolling in the specified course.

Request

Method: GET
\n
Endpoint: {{endpoint}}/records/{{record_id}}/course/prerequisites
\n

Path Parameters:

record_id: The unique identifier for the record associated with the course.

Response

The response will contain a JSON object that outlines the prerequisites for the course. The structure of the response typically includes:

prerequisites: An array of prerequisite courses, where each course may contain:
\n
- course_id: The unique identifier for the prerequisite course.
  \n
- course_name: The name of the prerequisite course.
  \n
- description: A brief description of the prerequisite course.
  \n
\n

This information helps users to determine the necessary courses they need to complete before taking the desired course.

\n","urlObject":{"path":["records","{{record_id}}","course","prerequisites"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45ba67a2-7ae1-46b8-98fc-d2705e1d89f0"},{"name":"Retrieve All Prerequisites to a Course Record (View Record permission)","id":"895a5e2e-8a68-465b-a7db-a1d2f99d214c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/prerequisiteto","description":"

Get Course Prerequisites

This endpoint retrieves the prerequisites for a specific course identified by the record_id. It allows users to access the necessary prerequisites that must be fulfilled before enrolling in the course.

Request Parameters

record_id (path parameter): The unique identifier for the course record. This parameter is required to specify which course's prerequisites are being requested.

Response

Upon a successful request, the API will return a JSON object containing the prerequisites for the specified course. The expected structure of the response is as follows:

{\n  \"prerequisites\": [\n    {\n      \"course_id\": \"string\",\n      \"course_name\": \"string\",\n      \"description\": \"string\"\n    }\n  ]\n}\n\n

JSON Schema for Response

prerequisites: An array of prerequisite courses.
\n
- course_id: The unique identifier for each prerequisite course (string).
  \n
- course_name: The name of the prerequisite course (string).
  \n
- description: A brief description of the prerequisite course (string).
  \n
\n

Example Response

{\n  \"prerequisites\": [\n    {\n      \"course_id\": \"CS101\",\n      \"course_name\": \"Introduction to Computer Science\",\n      \"description\": \"Fundamental concepts of computer science.\"\n    },\n    {\n      \"course_id\": \"MATH101\",\n      \"course_name\": \"Calculus I\",\n      \"description\": \"Basic principles of calculus.\"\n    }\n  ]\n}\n\n

This response provides users with the necessary information about the courses that must be completed prior to enrolling in the specified course.

This endpoint retrieves the prerequisites for a specific course identified by the record_id.

Request Parameters

record_id (path parameter, required): The unique identifier for the course record whose prerequisites you wish to retrieve.

Response

On a successful request, the API will return a response containing the prerequisites associated with the specified course. The structure of the response will include details relevant to the prerequisites, which may include information such as prerequisite course IDs or descriptions.

Notes

Ensure that the record_id provided is valid and corresponds to an existing course in the system.
\n
The response will return a status code of 200 OK if the prerequisites are successfully retrieved. In case of an error (e.g., invalid record_id), appropriate error codes will be returned.
\n

\n","urlObject":{"path":["records","{{record_id}}","course","prerequisiteto"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"895a5e2e-8a68-465b-a7db-a1d2f99d214c"},{"name":"Retrieve All Required Learners of a Course Record (View Record permission)","id":"fced1f42-fc74-44e1-b821-0889089aade0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/learners/required","description":"

GET /records/{{record_id}}/course/learners/required

This endpoint retrieves the list of required learners associated with a specific course record identified by record_id. It is useful for obtaining information about the learners who are mandatory for a particular course.

Input Parameters

record_id (path parameter): The unique identifier for the course record for which the required learners are being requested.

Response Structure

The response will include a JSON object containing the details of the required learners. The structure typically includes:

learners: An array of learner objects, each containing information such as:
\n
- learner_id: The unique identifier for the learner.
  \n
- name: The name of the learner.
  \n
- status: The current status of the learner in relation to the course.
  \n
\n

This endpoint is essential for course administrators and educators to track required participants for effective course management.

\n","urlObject":{"path":["records","{{record_id}}","course","learners","required"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fced1f42-fc74-44e1-b821-0889089aade0"},{"name":"Retrieve All Optional Learners of a Course Record (View Record permission)","id":"e390a11c-e323-48df-a5a8-8a1317a787f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/learners/optional","description":"

Get Optional Learners for a Course

This endpoint retrieves a list of optional learners associated with a specific course identified by record_id. It is primarily used to fetch learners who are not mandatory participants in the course.

Request Parameters

record_id (path parameter): The unique identifier for the course record. This parameter is required to specify which course's optional learners are being requested.

Response Structure

Upon a successful request, the API will return a JSON object containing the following structure:

data: An array that holds the optional learners' information. This may be empty if there are no optional learners.
\n
links: An object containing the self link, which provides the URL to the current resource.
\n
meta: An object that includes pagination information:
\n
- totalCount: The total number of optional learners available.
  \n
- pageCount: The number of pages available based on the current pagination setup.
  \n
- currentPage: The current page number of the results.
  \n
- perPage: The number of results per page.
  \n
\n

Sample Response

{\n  \"data\": [],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

In this sample response, the data array is empty, indicating that there are currently no optional learners associated with the specified course.

This endpoint retrieves a list of optional learners associated with a specific course record identified by record_id. It is designed to provide information about learners who have the option to participate in the course.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{record_id}}/course/learners/optional
\n

Path Parameters

record_id (string): The unique identifier for the course record. This parameter is required to specify which course's optional learners you want to retrieve.

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

Response Structure

The response body contains the following structure:

data (array): An array that holds the optional learners' information. In this case, it is empty, indicating there are no optional learners for the specified course.
\n
links (object): Contains pagination links.
\n
- self (object): An object that includes the href key with the URL to the current endpoint.
\n
meta (object): Provides metadata about the response.
\n
- totalCount (integer): The total number of optional learners found.
  \n
- pageCount (integer): The total number of pages available.
  \n
- currentPage (integer): The current page number of the results.
  \n
- perPage (integer): The number of results per page.
  \n
\n

Example Response

{\n  \"data\": [],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

This response indicates that there are currently no optional learners associated with the specified course record.

\n","urlObject":{"path":["records","{{record_id}}","course","learners","optional"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e390a11c-e323-48df-a5a8-8a1317a787f9"},{"name":"Retrieve All Trainers of a Course Record (View Record permission)","id":"07666c9b-0087-41c7-96dc-f00e55c933f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/trainers","description":"

Endpoint Description: Retrieve Trainers for a Course

This endpoint retrieves a list of trainers associated with a specific course record identified by record_id. It provides detailed information about each trainer, including their attributes and relationships within the context of the course.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{record_id}}/course/trainers
\n

Path Parameters

record_id (required): The unique identifier for the course record whose trainers are being retrieved.

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

Response Structure

The response body contains the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"actortypevalue\": 0,\n        \"actortype\": \"\"\n      },\n      \"relationships\": {\n        \"record\": {\n          \"data\": {\n            \"id\": 0,\n            \"type\": \"\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

Response Details

data: An array containing trainer objects. Each object includes:
\n
- type: The type of the trainer (string).
  \n
- id: The unique identifier for the trainer (string).
  \n
- attributes: Contains:
  \n
  - actortypevalue: A numeric value representing the type of actor (integer).
    \n
  - actortype: A string describing the type of actor.
    \n
  \n
- relationships: Contains:
  \n
  - record: An object that links to the course record, including:
    \n
    - data: An object with id and type of the related record.
    \n
  \n
\n
links: Provides pagination links for navigating through the data:
\n
- self: A link to the current page.
  \n
- first: A link to the first page of results.
  \n
- last: A link to the last page of results.
  \n
\n
meta: Contains metadata about the response:
\n
- totalCount: Total number of trainers available (integer).
  \n
- pageCount: Total number of pages available (integer).
  \n
- currentPage: The current page number (integer).
  \n
- perPage: Number of items per page (integer).
  \n
\n

This response format allows clients to easily navigate through the list of trainers and understand their attributes and relationships to the course record.

This endpoint retrieves a list of trainers associated with a specific course identified by the record_id. It is useful for obtaining information about the individuals responsible for training in a particular course.

Request Parameters

record_id (path parameter): The unique identifier of the course for which the trainers are being requested.

Response Structure

The response will typically include a JSON object containing:

trainers: An array of trainer objects, each containing details about the trainers associated with the specified course. Each trainer object may include keys such as:
\n
- id: The unique identifier for the trainer.
  \n
- name: The name of the trainer.
  \n
- expertise: The areas of expertise of the trainer.
  \n
- contact_info: Contact details for the trainer.
  \n
\n

This structure allows clients to easily access and utilize the information about course trainers.

\n","urlObject":{"path":["records","{{record_id}}","course","trainers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"07666c9b-0087-41c7-96dc-f00e55c933f9"},{"name":"Retrieve All Certificate Templates of a Course Record (View Record permission)","id":"60b7fb65-79e7-4004-a500-23a50ddc339b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/certificates","description":"

Retrieve Course Certificates

This endpoint allows you to retrieve the certificates associated with a specific course record.

HTTP Method

GET

Endpoint

{{endpoint}}/records/{{record_id}}/course/certificates

Path Parameters

record_id (string): The unique identifier for the course record whose certificates you want to retrieve.

Expected Response

Upon a successful request, the response will contain a list of certificates associated with the specified course record. The response format will typically be in JSON, containing details about each certificate.

Example Response Structure

{\n    \"certificates\": [\n        {\n            \"id\": \"string\",\n            \"title\": \"string\",\n            \"issued_date\": \"date\",\n            \"expiration_date\": \"date\"\n        }\n    ]\n}\n\n

Notes

Ensure that the record_id is valid and corresponds to an existing course record to receive the correct certificates.

\n","urlObject":{"path":["records","{{record_id}}","course","certificates"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60b7fb65-79e7-4004-a500-23a50ddc339b"},{"name":"Retrieve All Certificate Templates Pages of a Course Record and Certificate (View Record permission)","id":"b476e422-ba9c-404c-8a7a-3a19f68b7a3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/certificates/{{certificate_id}}/pages","description":"

Endpoint Description

This endpoint retrieves the pages associated with a specific certificate within a course record. It provides detailed information about each page, including its attributes and relationships.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{record_id}}/course/certificates/{{certificate_id}}/pages
\n

Path Parameters

record_id (string): The unique identifier for the course record.
\n
certificate_id (string): The unique identifier for the certificate.
\n

Response

Status Code: 200
\n
Content-Type: application/json
\n

Response Structure

The response contains a JSON object with the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"<string>\",\n      \"id\": \"<string>\",\n      \"attributes\": {\n        \"name\": \"<string>\",\n        \"setting\": \"<string>\",\n        \"content\": \"<string>\",\n        \"formatted_content\": \"<string>\",\n        \"fields\": \"<string>\",\n        \"position\": <integer>,\n        \"prompt\": \"<string>\",\n        \"latest_variables\": \"<string>\",\n        \"loop_fields\": \"<string>\",\n        \"data_source\": <integer>,\n        \"data_source_meta\": <integer>\n      },\n      \"relationships\": {\n        \"report\": {\n          \"data\": {\n            \"id\": <integer>,\n            \"type\": \"<string>\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"<string>\"\n    },\n    \"first\": {\n      \"href\": \"<string>\"\n    },\n    \"last\": {\n      \"href\": \"<string>\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": <integer>,\n    \"pageCount\": <integer>,\n    \"currentPage\": <integer>,\n    \"perPage\": <integer>\n  }\n}\n\n

Response Details

data: An array of page objects, each containing:
\n
- type: The type of the page.
  \n
- id: The unique identifier of the page.
  \n
- attributes: An object containing various properties of the page such as name, setting, content, etc.
  \n
- relationships: An object that defines relationships to other resources, such as reports.
  \n
\n
links: Provides pagination links for navigating through the pages.
\n
- self: The URL of the current page.
  \n
- first: The URL of the first page.
  \n
- last: The URL of the last page.
  \n
\n
meta: Contains metadata about the response, including:
\n
- totalCount: Total number of pages available.
  \n
- pageCount: Number of pages returned in this response.
  \n
- currentPage: The current page number.
  \n
- perPage: Number of items per page.
  \n
\n

This endpoint is useful for fetching structured information about the pages related to a specific certificate, allowing clients to display or process this data as needed.

This endpoint retrieves the pages associated with a specific course certificate. It provides detailed information about each page, including its attributes and relationships.

Request

Method: GET
\n
URL: {{endpoint}}/records/{{record_id}}/course/certificates/{{certificate_id}}/pages
\n

Path Parameters

record_id (string): The unique identifier of the record.
\n
certificate_id (string): The unique identifier of the course certificate.
\n

Response

On a successful request, the API returns a 200 OK status with a JSON response containing the following structure:

data (array): An array of page objects, each containing:
\n
- type (string): The type of the page.
  \n
- id (string): The unique identifier of the page.
  \n
- attributes (object): Contains detailed attributes of the page:
  \n
  - name (string): The name of the page.
    \n
  - setting (string): The setting associated with the page.
    \n
  - content (string): The content of the page.
    \n
  - formatted_content (string): The formatted content for display.
    \n
  - fields (string): The fields related to the page.
    \n
  - position (integer): The position of the page in the sequence.
    \n
  - prompt (string): The prompt associated with the page.
    \n
  - latest_variables (string): The latest variables used in the page.
    \n
  - loop_fields (string): Fields that may be looped through.
    \n
  - data_source (integer): Identifier for the data source.
    \n
  - data_source_meta (integer): Metadata related to the data source.
    \n
  \n
- relationships (object): Contains relationships to other resources:
  \n
  - report (object): Contains the report data with:
    \n
    - data (object): Includes:
      \n
      - id (integer): The identifier of the report.
        \n
      - type (string): The type of the report.
        \n
      \n
    \n
  \n
\n
links (object): Contains pagination links:
\n
- self (object): The link to the current resource.
  \n
- first (object): The link to the first page of results.
  \n
- last (object): The link to the last page of results.
  \n
\n
meta (object): Contains metadata about the response:
\n
- totalCount (integer): Total number of items available.
  \n
- pageCount (integer): Total number of pages.
  \n
- currentPage (integer): The current page number.
  \n
- perPage (integer): Number of items per page.
  \n
\n

This endpoint is essential for obtaining structured information about course certificate pages, which can be utilized for further processing or display in applications.

\n","urlObject":{"path":["records","{{record_id}}","course","certificates","{{certificate_id}}","pages"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b476e422-ba9c-404c-8a7a-3a19f68b7a3e"},{"name":"Retrieve All Materials for a Version of a Course Record (View Record permission)","id":"11ffbd10-fd38-46bf-9b40-aca611176711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials","description":"

Retrieve Course Materials

This endpoint retrieves the materials associated with a specific course version.

HTTP Method

GET

Endpoint

{{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials

Path Parameters

record_id (string): The unique identifier for the record.
\n
version_id (string): The unique identifier for the course version.
\n

Expected Response

Upon a successful request, the API will return a 200 OK status with a JSON response containing the following structure:

{\n    \"data\": [\n        {\n            \"type\": \"\",\n            \"id\": \"\",\n            \"attributes\": {\n                \"owner_id\": 0,\n                \"type\": \"\",\n                \"path\": \"\",\n                \"name\": \"\",\n                \"description\": \"\",\n                \"modify_reason\": null,\n                \"date_updated\": 0,\n                \"last_user_id\": 0,\n                \"order\": 0\n            }\n        }\n    ],\n    \"links\": {\n        \"self\": {\n            \"href\": \"\"\n        },\n        \"first\": {\n            \"href\": \"\"\n        },\n        \"last\": {\n            \"href\": \"\"\n        }\n    },\n    \"meta\": {\n        \"totalCount\": 0,\n        \"pageCount\": 0,\n        \"currentPage\": 0,\n        \"perPage\": 0\n    }\n}\n\n

Response Fields

data: An array of material objects, each containing:
\n
- type: The type of material.
  \n
- id: The unique identifier for the material.
  \n
- attributes: An object with the following fields:
  \n
  - owner_id: ID of the owner of the material.
    \n
  - type: Type of the material.
    \n
  - path: Path to the material.
    \n
  - name: Name of the material.
    \n
  - description: Description of the material.
    \n
  - modify_reason: Reason for the last modification (can be null).
    \n
  - date_updated: Timestamp of the last update.
    \n
  - last_user_id: ID of the last user who modified the material.
    \n
  - order: Order of the material in the list.
    \n
  \n
\n
links: Pagination links for navigating through the materials.
\n
meta: Metadata about the response, including counts for total items and pagination.
\n

This endpoint is useful for accessing and managing course materials effectively.

This endpoint retrieves the materials associated with a specific version of a course record.

Request

Method: GET
\n
Endpoint: {{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials
\n

Path Parameters

record_id (string): The unique identifier of the course record.
\n
version_id (string): The identifier for the specific version of the course.
\n

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

Response Body

The response will contain a JSON object structured as follows:

data: An array of material objects, each containing:
\n
- type: The type of the material.
  \n
- id: The unique identifier for the material.
  \n
- attributes: An object with the following properties:
  \n
  - owner_id: The ID of the owner of the material.
    \n
  - type: The type of the material.
    \n
  - path: The file path of the material.
    \n
  - name: The name of the material.
    \n
  - description: A brief description of the material.
    \n
  - modify_reason: The reason for the last modification (can be null).
    \n
  - date_updated: The timestamp of the last update.
    \n
  - last_user_id: The ID of the user who last modified the material.
    \n
  - order: The order of the material in the list.
    \n
  \n
\n
links: Pagination links for navigating through the materials:
\n
- self: Link to the current page.
  \n
- first: Link to the first page.
  \n
- last: Link to the last page.
  \n
\n
meta: Metadata about the response:
\n
- totalCount: Total number of materials available.
  \n
- pageCount: Total number of pages available.
  \n
- currentPage: The current page number.
  \n
- perPage: Number of items per page.
  \n
\n

This endpoint is useful for obtaining detailed information about the materials related to a specific course version.

\n","urlObject":{"path":["records","{{record_id}}","course","versions","{{version_id}}","materials"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"11ffbd10-fd38-46bf-9b40-aca611176711"},{"name":"Retrieve All Settings for a Material for a Version of a Course Record (View Record permission)","id":"bffd6287-29c8-4bb8-9dc4-32ee36156e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials/{{material_id}}/settings","description":"

Endpoint Description

This endpoint retrieves the settings for a specific material within a course version. It is accessed via an HTTP GET request to the following URL:

GET {{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials/{{material_id}}/settings\n\n

Request Parameters

record_id: The unique identifier for the record.
\n
version_id: The unique identifier for the course version.
\n
material_id: The unique identifier for the material.
\n

Response Format

Upon a successful request, the server responds with a status code of 200 and a JSON object containing the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"name\": \"\",\n        \"value\": 0\n      },\n      \"relationships\": {\n        \"material\": {\n          \"data\": {\n            \"id\": 0,\n            \"type\": \"\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

Response Structure

data: An array of objects representing the settings for the material. Each object contains:
\n
- type: A string indicating the type of the resource.
  \n
- id: A string representing the unique identifier of the resource.
  \n
- attributes: An object containing:
  \n
  - name: A string representing the name of the setting.
    \n
  - value: A numeric value associated with the setting.
    \n
  \n
- relationships: An object that includes:
  \n
  - material: An object containing the relationship to the material, with:
    \n
    - data: An object that holds:
      \n
      - id: The unique identifier for the material.
        \n
      - type: A string indicating the type of the material.
        \n
      \n
    \n
  \n
\n
links: An object containing pagination links:
\n
- self: A link to the current resource.
  \n
- first: A link to the first page of results.
  \n
- last: A link to the last page of results.
  \n
\n
meta: An object providing metadata about the response, including:
\n
- totalCount: The total number of items available.
  \n
- pageCount: The number of pages available.
  \n
- currentPage: The current page number.
  \n
- perPage: The number of items per page.
  \n
\n

This endpoint retrieves the settings for a specific material associated with a course version. The request is made to the following URL:

GET {{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials/{{material_id}}/settings\n\n

Request Parameters

record_id: The unique identifier for the record.
\n
version_id: The identifier for the specific version of the course.
\n
material_id: The identifier for the material whose settings are being retrieved.
\n

Response Format

On a successful request, the server responds with a 200 OK status and a JSON object containing the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"name\": \"\",\n        \"value\": 0\n      },\n      \"relationships\": {\n        \"material\": {\n          \"data\": {\n            \"id\": 0,\n            \"type\": \"\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

data: An array containing the settings for the specified material. Each object in the array includes:
\n
- type: The type of the resource.
  \n
- id: The unique identifier for the resource.
  \n
- attributes: Contains the name and value of the material settings.
  \n
- relationships: Describes the relationship with the material, including its id and type.
  \n
\n
links: Provides pagination links for navigating through the settings, including self, first, and last links.
\n
meta: Contains metadata about the response, such as totalCount, pageCount, currentPage, and perPage.
\n

This endpoint is essential for fetching the configuration details of materials used in a course version, allowing users to understand how materials are set up within the course.

\n","urlObject":{"path":["records","{{record_id}}","course","versions","{{version_id}}","materials","{{material_id}}","settings"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bffd6287-29c8-4bb8-9dc4-32ee36156e83"},{"name":"Retrieve All FIles for a Material for a Version of a Course Record (View Record permission)","id":"245068a8-d6f3-479f-bd29-1b47e14a1427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials/{{material_id}}/files","description":"

Endpoint Description

This endpoint retrieves the files associated with a specific material version in a course record. It allows users to access various files linked to a particular material, identified by its unique IDs.

Request Parameters

record_id (path parameter): The unique identifier for the course record.
\n
version_id (path parameter): The identifier for the specific version of the course material.
\n
material_id (path parameter): The unique identifier for the material whose files are being requested.
\n

Response

Upon a successful request, the API returns a 200 OK status with a JSON response. The response body contains the following structure:

data: An array that holds the files associated with the requested material. In this case, it may be empty if no files are found.
\n
links: Contains a self-referential link to the current resource.
\n
- self: An object that provides the URL to access the current resource.
\n
meta: Provides metadata about the response.
\n
- totalCount: The total number of files available for the requested material.
  \n
- pageCount: The total number of pages of results (if pagination is applicable).
  \n
- currentPage: The current page number of results being returned.
  \n
- perPage: The number of results returned per page.
  \n
\n

Sample Response Body

{\n    \"data\": [],\n    \"links\": {\n        \"self\": {\n            \"href\": \"\"\n        }\n    },\n    \"meta\": {\n        \"totalCount\": 0,\n        \"pageCount\": 0,\n        \"currentPage\": 0,\n        \"perPage\": 0\n    }\n}\n\n

This response indicates that there are currently no files associated with the specified material.

This endpoint retrieves files associated with a specific course material version. The request is made using the HTTP GET method and requires several path parameters to specify the exact resource being accessed.

Request Parameters

record_id (string): The unique identifier for the record.
\n
version_id (string): The identifier for the specific version of the course.
\n
material_id (string): The identifier for the specific material within the course version.
\n

Expected Response

Upon a successful request, the server will respond with a status code of 200 and a JSON object containing the following structure:

{\n  \"data\": [],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

Response Schema

data (array): An array containing the files associated with the specified course material. In this case, it is an empty array indicating no files are available.
\n
links (object): Contains links related to the request.
\n
- self (object): An object containing the href property which points to the current resource.
\n
meta (object): Metadata about the response.
\n
- totalCount (integer): The total number of files available.
  \n
- pageCount (integer): The total number of pages available for pagination.
  \n
- currentPage (integer): The current page number of the response.
  \n
- perPage (integer): The number of items per page.
  \n
\n

This endpoint is useful for clients needing to access files related to specific course materials, enabling them to manage and utilize educational resources effectively.

This endpoint retrieves the files associated with a specific material version within a course record. It allows users to access the files linked to a particular material identified by its material_id, within the context of a specific course version and record.

Request Parameters

record_id (path parameter): The unique identifier for the course record.
\n
version_id (path parameter): The identifier for the specific version of the course.
\n
material_id (path parameter): The unique identifier for the material whose files are being requested.
\n

Response

Upon a successful request, the API returns a 200 OK status with a JSON response. The structure of the response is as follows:

data: An array containing the files associated with the specified material. In this case, it appears to be empty, indicating no files are currently linked.
\n
links: Contains a self link that provides the URL for the current request.
\n
meta: Provides metadata about the response, including:
\n
- totalCount: The total number of files found (0 in this case).
  \n
- pageCount: The number of pages of results (0 in this case).
  \n
- currentPage: The current page number (0 in this case).
  \n
- perPage: The number of results per page (0 in this case).
  \n
\n

Notes

Ensure that the record_id, version_id, and material_id are valid and correspond to existing entities in the system to receive the expected results.
\n
If no files are associated with the specified material, the data array will be empty, and the totalCount will reflect this.
\n

\n","urlObject":{"path":["records","{{record_id}}","course","versions","{{version_id}}","materials","{{material_id}}","files"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"245068a8-d6f3-479f-bd29-1b47e14a1427"},{"name":"Retrieve All Questions for a Material for a Version of a Course Record (View Record permission)","id":"eae30487-feeb-461e-aeb9-ad7cca524744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/versions/{{version_id}}/materials/{{material_id}}/questions","description":"

Retrieve Questions for Course Material

This endpoint retrieves a list of questions associated with a specific material version in a course. The request requires identifying parameters such as the record ID, version ID, and material ID to fetch the relevant questions.

Request Parameters

record_id (path parameter): The unique identifier for the course record.
\n
version_id (path parameter): The version identifier of the course material.
\n
material_id (path parameter): The unique identifier for the material from which questions are being retrieved.
\n

Response

On a successful request, the API responds with a status code of 200 and returns a JSON object containing the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"question\": \"\",\n        \"type\": \"\",\n        \"configuration\": \"\",\n        \"answer\": null,\n        \"order\": 0\n      },\n      \"relationships\": {\n        \"material\": {\n          \"data\": {\n            \"id\": 0,\n            \"type\": \"\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

JSON Schema for Response

data: An array of question objects.
\n
- type: (string) The type of the question.
  \n
- id: (string) The unique identifier for the question.
  \n
- attributes: An object containing details about the question.
  \n
  - question: (string) The text of the question.
    \n
  - type: (string) The type of question (e.g., multiple choice, true/false).
    \n
  - configuration: (string) Additional configuration for the question.
    \n
  - answer: (null or any type) The answer to the question, if applicable.
    \n
  - order: (integer) The order of the question in the list.
    \n
  \n
- relationships: An object that defines relationships to other resources.
  \n
  - material: An object containing the material data.
    \n
    - data: An object with the material's ID and type.
      \n
      - id: (integer) The unique identifier for the material.
        \n
      - type: (string) The type of the material.
        \n
      \n
    \n
  \n
\n
links: An object containing pagination links.
\n
- self: (object) Link to the current resource.
  \n
- first: (object) Link to the first page of results.
  \n
- last: (object) Link to the last page of results.
  \n
\n
meta: An object containing metadata about the response.
\n
- totalCount: (integer) Total number of questions available.
  \n
- pageCount: (integer) Number of pages of results.
  \n
- currentPage: (integer) The current page number.
  \n
- perPage: (integer) Number of items per page.
  \n
\n

This endpoint is useful for retrieving questions related to specific course materials, enabling users to access and manage educational content effectively.

This endpoint retrieves a list of questions associated with a specific material version within a course. It is useful for accessing the questions that are linked to a particular material, allowing users to review or utilize them as needed.

Request Parameters

record_id (path parameter): The unique identifier for the record.
\n
version_id (path parameter): The specific version identifier of the course.
\n
material_id (path parameter): The identifier for the material whose questions are being requested.
\n

Response Structure

On a successful request, the response will contain a JSON object with the following structure:

data: An array of question objects, each containing:
\n
- type: The type of the question.
  \n
- id: The unique identifier for the question.
  \n
- attributes: An object containing:
  \n
  - question: The text of the question.
    \n
  - type: The type of question (e.g., multiple choice, true/false).
    \n
  - configuration: Additional configuration details for the question.
    \n
  - answer: The correct answer for the question (if applicable).
    \n
  - order: The order of the question in the list.
    \n
  \n
- relationships: An object that includes:
  \n
  - material: A reference to the material associated with the question, containing:
    \n
    - data: An object with:
      \n
      - id: The identifier of the material.
        \n
      - type: The type of the material.
        \n
      \n
    \n
  \n
\n
links: Pagination links for navigating through the questions:
\n
- self: A link to the current page of results.
  \n
- first: A link to the first page of results.
  \n
- last: A link to the last page of results.
  \n
\n
meta: Metadata about the response, including:
\n
- totalCount: The total number of questions available.
  \n
- pageCount: The number of pages of results.
  \n
- currentPage: The current page number.
  \n
- perPage: The number of items per page.
  \n
\n

Notes

Ensure that the provided IDs are valid and correspond to existing records, versions, and materials to avoid errors in the response.
\n
The response may include an empty array if there are no questions associated with the specified material.
\n

\n","urlObject":{"path":["records","{{record_id}}","course","versions","{{version_id}}","materials","{{material_id}}","questions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eae30487-feeb-461e-aeb9-ad7cca524744"},{"name":"Retrieve All Versions of a Course Record (View Record permission)","id":"ebd68625-c349-400c-bdcc-9e37d98b9964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{record_id}}/course/versions","description":"

Get Course Versions

This endpoint retrieves the versions of a specific course associated with a given record ID. It is useful for obtaining the history of changes made to the course.

Request

Method: GET
\n
Endpoint: {{endpoint}}/records/{{record_id}}/course/versions
\n

Path Parameters

record_id (required): The unique identifier for the record whose course versions are being requested.

Response

Status Code: 200 OK
\n
Content-Type: application/json
\n

Response Format

The response will contain a JSON object with the following structure:

{\n  \"data\": [\n    {\n      \"type\": \"\",\n      \"id\": \"\",\n      \"attributes\": {\n        \"version\": 0,\n        \"status\": 0,\n        \"timestamp\": \"\",\n        \"date_effective\": null,\n        \"is_notified\": 0\n      },\n      \"relationships\": {\n        \"record\": {\n          \"data\": {\n            \"id\": 0,\n            \"type\": \"\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"\"\n    },\n    \"first\": {\n      \"href\": \"\"\n    },\n    \"last\": {\n      \"href\": \"\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 0,\n    \"pageCount\": 0,\n    \"currentPage\": 0,\n    \"perPage\": 0\n  }\n}\n\n

Sample Response

{\n  \"data\": [\n    {\n      \"type\": \"course_version\",\n      \"id\": \"1\",\n      \"attributes\": {\n        \"version\": 1,\n        \"status\": 1,\n        \"timestamp\": \"2023-10-01T12:00:00Z\",\n        \"date_effective\": null,\n        \"is_notified\": 1\n      },\n      \"relationships\": {\n        \"record\": {\n          \"data\": {\n            \"id\": 123,\n            \"type\": \"record\"\n          }\n        }\n      }\n    }\n  ],\n  \"links\": {\n    \"self\": {\n      \"href\": \"https://api.example.com/records/123/course/versions\"\n    },\n    \"first\": {\n      \"href\": \"https://api.example.com/records/123/course/versions?page=1\"\n    },\n    \"last\": {\n      \"href\": \"https://api.example.com/records/123/course/versions?page=10\"\n    }\n  },\n  \"meta\": {\n    \"totalCount\": 10,\n    \"pageCount\": 1,\n    \"currentPage\": 1,\n    \"perPage\": 10\n  }\n}\n\n

Notes

The data array contains the course versions, where each version has attributes such as version, status, timestamp, and is_notified.
\n
The links object provides pagination links for navigating through the results.
\n
The meta object includes information about the total count of versions and pagination details.
\n

This endpoint retrieves the versions of a specific course associated with a given record ID.

Method: GET
\n
Endpoint: {{endpoint}}/records/{{record_id}}/course/versions
\n

Parameters

record_id (path parameter): The unique identifier for the record whose course versions are being requested. This parameter is required.

Expected Response

The response will contain a list of course versions associated with the specified record. The format of the response is typically JSON, and it includes details such as version identifiers and any associated metadata.

Additional Notes

Ensure that the record_id provided is valid and corresponds to an existing record in the system.
\n
The response may vary based on the number of versions available for the specified course.
\n

\n","urlObject":{"path":["records","{{record_id}}","course","versions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ebd68625-c349-400c-bdcc-9e37d98b9964"}],"id":"d478ee85-3ce8-49de-a0cd-90e796b3d278","_postman_id":"d478ee85-3ce8-49de-a0cd-90e796b3d278","description":""},{"name":"Search Learning Users","id":"52e60143-30ca-48bb-a005-ba155c3b3438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"aql\": \"select id, learning_id, status, date_assigned, date_expire, date_due, active from __main__ where id eq 1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/learning-users/search","description":"

Summary\nSearches learning users using an AQL (ACE Query Language) expression and returns matching learning-user IDs. Supports paginated results.

Authentication and Headers

Authorization: Bearer (required). Set at the collection or request level.
Content-Type: application/json
Accept: application/json

Request Body\nType: application/json\nSchema (guide):\n{\n \"type\": \"object\",\n \"properties\": {\n \"aql\": { \"type\": \"string\" }\n },\n \"required\": [\"aql\"]\n}

AQL examples

{ \"aql\": \"select id from main where retrain_status eq 1\" }
{ \"aql\": \"select id from main where id eq 1\" }

Example Successful Response (200)\n{\n \"data\": [\n {\"type\": \"learning-users\", \"id\": \"52\", \"attributes\": {\"id\": 52}},\n {\"type\": \"learning-users\", \"id\": \"53\", \"attributes\": {\"id\": 53}},\n {\"type\": \"learning-users\", \"id\": \"56\", \"attributes\": {\"id\": 56}},\n {\"type\": \"learning-users\", \"id\": \"62\", \"attributes\": {\"id\": 62}},\n {\"type\": \"learning-users\", \"id\": \"149\", \"attributes\": {\"id\": 149}},\n {\"type\": \"learning-users\", \"id\": \"150\", \"attributes\": {\"id\": 150}},\n {\"type\": \"learning-users\", \"id\": \"157\", \"attributes\": {\"id\": 157}},\n {\"type\": \"learning-users\", \"id\": \"158\", \"attributes\": {\"id\": 158}},\n {\"type\": \"learning-users\", \"id\": \"205\", \"attributes\": {\"id\": 205}},\n {\"type\": \"learning-users\", \"id\": \"222\", \"attributes\": {\"id\": 222}}\n ],\n \"links\": {\n \"self\": {\"href\": \"/backend/v3/learning-users/search?page=1\"},\n \"first\": {\"href\": \"/backend/v3/learning-users/search?page=1\"},\n \"last\": {\"href\": \"/backend/v3/learning-users/search?page=5\"},\n \"next\": {\"href\": \"/backend/v3/learning-users/search?page=2\"}\n },\n \"meta\": {\n \"totalCount\": 1014,\n \"pageCount\": 51,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}

Pagination Notes

Use the links.next/links.last to navigate pages.
meta.totalCount: total matching records.
meta.pageCount: total pages available.
meta.currentPage: current page index (1-based).
meta.perPage: items per page.

Navigation

Collection: ACE API
Request: Search Learning Users

\n","urlObject":{"path":["learning-users","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"52e60143-30ca-48bb-a005-ba155c3b3438"},{"name":"Get Learning Users","id":"6c3dda55-5643-4923-8933-fed208ab9c57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/learning-users/search?limit=8","description":"

Summary
Searches learning users using an AQL (ACE Query Language) expression and returns matching learning-user IDs. Supports paginated results.

Authentication and Headers

Authorization: Bearer (required). Set at the collection or request level.
\n
Content-Type: application/json
\n
Accept: application/json
\n

Request Body
Type: application/json
Schema (guide):
{
\"type\": \"object\",
\"properties\": {
\"aql\": { \"type\": \"string\" }
},
\"required\": [\"aql\"]
}

AQL examples

{ \"aql\": \"select id from main where retrain_status eq 1\" }
\n
{ \"aql\": \"select id from main where id eq 1\" }
\n

Example Successful Response (200)
{
\"data\": [
{\"type\": \"learning-users\", \"id\": \"52\", \"attributes\": {\"id\": 52}},
{\"type\": \"learning-users\", \"id\": \"53\", \"attributes\": {\"id\": 53}},
{\"type\": \"learning-users\", \"id\": \"56\", \"attributes\": {\"id\": 56}},
{\"type\": \"learning-users\", \"id\": \"62\", \"attributes\": {\"id\": 62}},
{\"type\": \"learning-users\", \"id\": \"149\", \"attributes\": {\"id\": 149}},
{\"type\": \"learning-users\", \"id\": \"150\", \"attributes\": {\"id\": 150}},
{\"type\": \"learning-users\", \"id\": \"157\", \"attributes\": {\"id\": 157}},
{\"type\": \"learning-users\", \"id\": \"158\", \"attributes\": {\"id\": 158}},
{\"type\": \"learning-users\", \"id\": \"205\", \"attributes\": {\"id\": 205}},
{\"type\": \"learning-users\", \"id\": \"222\", \"attributes\": {\"id\": 222}}
],
\"links\": {
\"self\": {\"href\": \"/backend/v3/learning-users/search?page=1\"},
\"first\": {\"href\": \"/backend/v3/learning-users/search?page=1\"},
\"last\": {\"href\": \"/backend/v3/learning-users/search?page=5\"},
\"next\": {\"href\": \"/backend/v3/learning-users/search?page=2\"}
},
\"meta\": {
\"totalCount\": 1014,
\"pageCount\": 51,
\"currentPage\": 1,
\"perPage\": 20
}
}

Pagination Notes

Use the links.next/links.last to navigate pages.
\n
meta.totalCount: total matching records.
\n
meta.pageCount: total pages available.
\n
meta.currentPage: current page index (1-based).
\n
meta.perPage: items per page.
\n

Navigation

Collection: ACE API
\n
Request: Search Learning Users
\n

\n","urlObject":{"path":["learning-users","search"],"host":["{{endpoint}}"],"query":[{"key":"limit","value":"8"}],"variable":[]}},"response":[],"_postman_id":"6c3dda55-5643-4923-8933-fed208ab9c57"}],"id":"8bd6d2d2-7d4c-48cb-bb12-cf2d852f9831","_postman_id":"8bd6d2d2-7d4c-48cb-bb12-cf2d852f9831","description":""},{"name":"ACE ASSESSMENT","item":[{"name":"Retrieve All Assessment Templates of an Assessment Record (View Record permission)","id":"1df9568d-8f4b-4046-bdfd-7c1399a40847","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{assessment_record_id}}/assessment/templates","urlObject":{"path":["records","{{assessment_record_id}}","assessment","templates"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1df9568d-8f4b-4046-bdfd-7c1399a40847"},{"name":"Retrieve All Recipients of an Assessment Record (View Record permission)","id":"14a0ece3-872b-4a28-a105-b2c891adc4ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{assessment_record_id}}/assessment/templates/{{template_id}}/recipients","urlObject":{"path":["records","{{assessment_record_id}}","assessment","templates","{{template_id}}","recipients"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"14a0ece3-872b-4a28-a105-b2c891adc4ac"},{"name":"Retrieve All Organizers of an Assessment Record (View Record permission)","id":"872574bc-3d31-4fef-9a14-5b49d464a5ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/records/{{assessment_record_id}}/assessment/templates/{{template_id}}/organizers","urlObject":{"path":["records","{{assessment_record_id}}","assessment","templates","{{template_id}}","organizers"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"872574bc-3d31-4fef-9a14-5b49d464a5ab"},{"name":"Retrieve All Settings of an Assessment Record (View Record permission)","id":"2e164392-92f4-43d0-a706-87cf9fa563d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{endpoint}}/records/{{assessment_record_id}}/assessment/templates/{{template_id}}/settings","urlObject":{"path":["records","{{assessment_record_id}}","assessment","templates","{{template_id}}","settings"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e164392-92f4-43d0-a706-87cf9fa563d7"},{"name":"Get Assessment Templates","id":"45356c4c-c0ee-41b8-a3c7-1e8584471d17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/checklists/search","urlObject":{"path":["checklists","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45356c4c-c0ee-41b8-a3c7-1e8584471d17"},{"name":"Get Assessment Template Versions","id":"be1b52d3-6ae9-4b85-a400-fc8869a67ea5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/checklist-versions/search","urlObject":{"path":["checklist-versions","search"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be1b52d3-6ae9-4b85-a400-fc8869a67ea5"},{"name":"Get Assessment Subsections","id":"fa2e5c27-83d5-4925-be73-96555281a663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/checklists/{{checklist_id}}/subsections","urlObject":{"path":["checklists","{{checklist_id}}","subsections"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa2e5c27-83d5-4925-be73-96555281a663"},{"name":"Get Assessment Questions","id":"886e2e2c-e1d4-42b5-b6a8-8c08a4fa9390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/checklists/{{checklist_id}}/subsections/{{subsection_id}}/questions","urlObject":{"path":["checklists","{{checklist_id}}","subsections","{{subsection_id}}","questions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"886e2e2c-e1d4-42b5-b6a8-8c08a4fa9390"},{"name":"Get Assessment Responses","id":"e5a395d3-ad8b-44e1-8426-d0a4973f6f9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/checklists/{{checklist_id}}/responses","urlObject":{"path":["checklists","{{checklist_id}}","responses"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5a395d3-ad8b-44e1-8426-d0a4973f6f9f"},{"name":"Get Assessment Response Options","id":"22ce91b7-5275-4ef6-bbe0-f1f422a81a08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{endpoint}}/checklists/{{checklist_id}}/responses/{{response_id}}/roptions","urlObject":{"path":["checklists","{{checklist_id}}","responses","{{response_id}}","roptions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"22ce91b7-5275-4ef6-bbe0-f1f422a81a08"},{"name":"Get Assessment Conditions","id":"4b7cfcc3-f928-45f0-b9fb-d973aac4d8d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/checklists/{{checklist_id}}/conditions","urlObject":{"path":["checklists","{{checklist_id}}","conditions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b7cfcc3-f928-45f0-b9fb-d973aac4d8d2"}],"id":"37393d9d-7caa-4af1-8f74-33767bb09574","_postman_id":"37393d9d-7caa-4af1-8f74-33767bb09574","description":""}],"event":[{"listen":"prerequest","script":{"id":"33df0236-0827-4f4e-8b01-4520b39f97c6","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"31c0ccf9-49ad-4c84-8b8f-9c6f1fa75593","type":"text/javascript","requests":{},"exec":[""]}}]}