From eb07f48a0347e79ae6d91818e4b22d0a561fdbb9 Mon Sep 17 00:00:00 2001 From: Philip Ellis Date: Thu, 2 Nov 2023 13:14:37 -0500 Subject: [PATCH] added nerm collections --- dereferenced/deref-sailpoint-api.nerm.yaml | 16292 ++++++++++ postman/collections/sailpoint-api-nerm.json | 29491 ++++++++++++++++++ postman/links/nerm-link.txt | 1 + 3 files changed, 45784 insertions(+) create mode 100644 dereferenced/deref-sailpoint-api.nerm.yaml create mode 100644 postman/collections/sailpoint-api-nerm.json create mode 100644 postman/links/nerm-link.txt diff --git a/dereferenced/deref-sailpoint-api.nerm.yaml b/dereferenced/deref-sailpoint-api.nerm.yaml new file mode 100644 index 0000000..ba15648 --- /dev/null +++ b/dereferenced/deref-sailpoint-api.nerm.yaml @@ -0,0 +1,16292 @@ +openapi: 3.0.0 +info: + version: 1.0.0 + title: NERM API + description: The NERM API can be used to access and modify various resources in your environment. + license: + name: MIT +servers: + - url: 'https://{tenantName}.nonemployee.com/api' + variables: + tenantName: + default: acmeco + description: Tenant name assigned to customer +paths: + /user: + post: + summary: Create a new user + operationId: postUser + description: Create a new user + tags: + - users + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user: + type: object + properties: + name: + type: string + required: true + description: The user name + example: Bob + email: + type: string + format: email + required: true + description: The user email + example: test@sailpoint.com + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + description: The user type + example: NeprofileUser + profile_id: + type: string + format: uuid + description: The user profile id + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + title: + type: string + description: The user description + example: my_user_title + status: + type: string + enum: + - Active + - Disabled + required: true + description: The user status + example: Active + login: + type: string + required: true + description: The user login + example: my_user + group_strings: + type: string + description: The user group strings + example: 'Administrator_group,Developer_group' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user: + type: object + properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + title: + type: string + status: + type: string + enum: + - Active + - Disabled + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /users: + get: + summary: Get users + operationId: getUsers + description: This endpoint can retrieve users from Lifecycle or you can search for users using parameters + tags: + - users + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: name + in: query + description: object name for filtering + required: false + schema: + type: string + - name: login + in: query + description: The user login to search by + required: false + schema: + type: string + - name: title + in: query + description: The user title to search by + required: false + schema: + type: string + - name: status + in: query + description: status value for filtering + required: false + schema: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + - name: email + in: query + description: The user email to search by + required: false + schema: + type: string + format: email + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + title: + type: string + status: + type: string + enum: + - Active + - Disabled + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple new users + operationId: postUsers + description: Create multiple new users + tags: + - users + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + type: object + properties: + name: + type: string + required: true + description: The user name + example: Bob + email: + type: string + format: email + required: true + description: The user email + example: test@sailpoint.com + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + description: The user type + example: NeprofileUser + profile_id: + type: string + format: uuid + description: The user profile id + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + title: + type: string + description: The user description + example: my_user_title + status: + type: string + enum: + - Active + - Disabled + required: true + description: The user status + example: Active + login: + type: string + required: true + description: The user login + example: my_user + group_strings: + type: string + description: The user group strings + example: 'Administrator_group,Developer_group' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + users: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + title: + type: string + status: + type: string + enum: + - Active + - Disabled + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple users + operationId: patchUsers + description: Update multiple users + tags: + - users + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + required: true + writeOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + description: ID of the object to retrieve or update + name: + type: string + description: The name + example: myusername + email: + type: string + format: email + description: The email + example: test@sailpoint.com + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + description: Type of user + example: NeprofileUser + profile_id: + type: string + format: uuid + description: ID of the profile + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + title: + type: string + description: The title + example: Director + status: + type: string + enum: + - Active + - Disabled + description: Status of the user + example: Active + login: + type: string + description: The login + example: myLogin + group_strings: + type: string + description: The group strings + example: 'Administrator_group,Developer_group' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + users: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + title: + type: string + status: + type: string + enum: + - Active + - Disabled + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/users/{id}': + get: + summary: Find user by id + operationId: getUser + description: Info for a specific user + tags: + - users + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user: + type: object + properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + title: + type: string + status: + type: string + enum: + - Active + - Disabled + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a user by id + operationId: patchUser + description: Update a user by id + tags: + - users + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user: + type: object + properties: + id: + type: string + format: uuid + required: true + writeOnly: true + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + description: ID of the object to retrieve or update + name: + type: string + description: The name + example: myusername + email: + type: string + format: email + description: The email + example: test@sailpoint.com + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + description: Type of user + example: NeprofileUser + profile_id: + type: string + format: uuid + description: ID of the profile + example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e + title: + type: string + description: The title + example: Director + status: + type: string + enum: + - Active + - Disabled + description: Status of the user + example: Active + login: + type: string + description: The login + example: myLogin + group_strings: + type: string + description: The group strings + example: 'Administrator_group,Developer_group' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user: + type: object + properties: + id: + type: string + format: uuid + readonly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readonly: true + name: + type: string + email: + type: string + format: email + type: + type: string + enum: + - NeprofileUser + - NeaccessUser + default: NeprofileUser + title: + type: string + status: + type: string + enum: + - Active + - Disabled + login: + type: string + last_login: + type: string + format: date-time + readOnly: true + cookies_accepted_at: + type: string + format: date-time + readOnly: true + preferred_language: + type: string + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + delete: + summary: Delete a user + operationId: deleteUser + description: Delete a user + tags: + - users + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Info about the operation + content: + application/json: + schema: + type: object + properties: + info: + description: A message confirming the operation + example: object deleted + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/users/{id}/avatar': + get: + summary: Retrieves the URL of the user avatar + operationId: getUserAvatar + description: Retrieves the URL of the user avatar + tags: + - users + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Uploads a new user avatar + operationId: postUserAvatar + description: Uploads a new user avatar + tags: + - users + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /user_manager: + post: + summary: Create a new user-manager relationship + operationId: postUserManager + description: Create a new user-manager relationship + tags: + - user managers + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /user_managers: + get: + summary: Get user-manager relationships + operationId: getUserManagers + description: This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters + tags: + - user managers + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: user_id + in: query + description: The ID of a user for filtering + required: false + schema: + type: string + format: uuid + example: bba9cfb2-96c1-4acb-ac79-a21732527265 + - name: manager_id + in: query + description: The ID of a user for filtering + required: false + schema: + type: string + format: uuid + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple new user-manager relationships + operationId: postUserManagers + description: Create multiple new user-manager relationships + tags: + - user managers + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + type: object + properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + - type: object + properties: + user_managers: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple user-manager relationships + operationId: patchUserManagers + description: Update multiple user-manager relationships + tags: + - user managers + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_managers: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + - type: object + properties: + user_managers: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/user_managers/{id}': + get: + summary: Find user-manager relationship by id + operationId: getUserManager + description: Info for a specific user-manager relationship + tags: + - user managers + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a user-manager relationship by id + operationId: patchUserManager + description: Update a user-manager relationship by id + tags: + - user managers + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_manager: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /roles: + get: + summary: Get roles + operationId: getRoles + description: This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. + tags: + - roles + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: sponsors_role + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple new roles + operationId: postRoles + description: Create multiple new users + tags: + - roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + uid: + type: string + minLength: 32 + maxLength: 32 + example: sponsors_role + type: + type: string + enum: + - NeprofileRole + - NeaccessRole + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: sponsors_role + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple roles + operationId: patchRoles + description: Update multiple users + tags: + - roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + roles: + type: array + items: + type: object + properties: + type: + type: string + enum: + - NeprofileRole + - NeaccessRole + description: The type of role + example: NeprofileRole + name: + type: string + example: Sponsors + description: The name of the user role + archived: + type: boolean + description: 'Set to true to archive, false to unarchive' + example: true + groups: + type: array + description: Role groups + items: + type: string + example: ad_group_name + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: sponsors_role + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /role: + post: + summary: Create a new role + operationId: postRole + description: Create a new role + tags: + - roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role: + type: object + properties: + uid: + type: string + minLength: 32 + maxLength: 32 + example: sponsors_role + type: + type: string + enum: + - NeprofileRole + - NeaccessRole + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: sponsors_role + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/roles/{id}': + get: + summary: Find role by id + operationId: getRole + description: Info for a specific user role + tags: + - roles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: sponsors_role + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update an existing role + operationId: patchRole + description: Update an existing role + tags: + - roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role: + type: object + properties: + type: + type: string + enum: + - NeprofileRole + - NeaccessRole + description: The type of role + example: NeprofileRole + name: + type: string + example: Sponsors + description: The name of the user role + archived: + type: boolean + description: 'Set to true to archive, false to unarchive' + example: true + groups: + type: array + description: Role groups + items: + type: string + example: ad_group_name + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + example: sponsors_role + name: + type: string + example: Sponsors + groups: + type: array + items: + type: string + example: ad_group_name + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /permissions: + post: + summary: Create a permission + description: 'This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration' + operationId: createPermission + tags: + - permissions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + permission: + type: object + properties: + role_id: + type: string + format: uuid + description: The id of the role + example: ef5d413f-ba18-49e6-9a72-bb115aa133ff + subject_id: + type: string + format: uuid + example: db3d85ef-c324-458b-b206-58debaa96419 + description: The ID of the object that the permission is giving access to + value: + type: integer + format: int32 + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + example: 1 + description: The permissions level of access + subject: + type: integer + format: int32 + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + - 9 + - 10 + - 11 + - 12 + - 13 + - 14 + - 15 + - 16 + - 17 + - 18 + - 19 + - 20 + - 21 + - 22 + - 23 + example: 0 + description: The type of permission + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + permission: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + description: The id of the permission + example: 2e06b876-f456-473d-bd65-b6435e0b6b2d + role_id: + type: string + format: uuid + description: The id of the role + example: ef5d413f-ba18-49e6-9a72-bb115aa133ff + value: + type: integer + format: int32 + example: 1 + description: The permissions level of access + subject: + type: integer + format: int32 + example: 1 + description: The type of permission + subject_id: + type: string + format: uuid + example: db3d85ef-c324-458b-b206-58debaa96419 + description: The ID of the object that the permission is giving access to + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /user_role: + post: + summary: Assign a new role to a user + operationId: postUserRole + description: Assign a new role to a user + tags: + - user roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_role: + type: object + properties: + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_role: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /user_roles: + get: + summary: Get user role pairings + operationId: getUserRoles + description: This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters + tags: + - user roles + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: user_id + in: query + description: The ID of a user for filtering + required: false + schema: + type: string + format: uuid + example: bba9cfb2-96c1-4acb-ac79-a21732527265 + - name: role_id + in: query + description: The ID of a role for filtering + required: false + schema: + type: string + format: uuid + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple new user role pairings + operationId: postUserRoles + description: Create multiple new user role pairings + tags: + - user roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + type: object + properties: + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + user_roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple user role pairings + operationId: patchUserRoles + description: Update multiple user role pairings + tags: + - user roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + user_roles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/user_roles/{id}': + get: + summary: Find user role pairing by id + operationId: getUserRole + description: Info for a specific user role pairing + tags: + - user roles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_role: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a user role pairing by id + operationId: patchUserRole + description: Update a user role pairing by id + tags: + - user roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_role: + type: object + properties: + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_role: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + role_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/user_role/{id}': + delete: + summary: Delete a user role assignment + operationId: deleteUserRole + description: Delete a user role assignment + tags: + - user roles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: User role was destroyed + content: + application/json: + schema: + type: object + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /ne_attributes: + get: + summary: Get attribute data in bulk + operationId: getAttributes + description: This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters + tags: + - attributes + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: label + in: query + description: The attribute label to filter by + required: false + schema: + type: string + - name: data_type + in: query + description: The attribute data type to filter by + required: false + schema: + type: string + enum: + - text field + - text area + - drop-down + - radio buttons + - check boxes + - date + - tags + - attachment + - profile select + - profile search + - owner select + - owner search + - contributor select + - contributor search + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + ne_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + description: + type: string + tool_tip: + type: string + crypt: + type: boolean + archived: + type: boolean + archived_on: + type: string + format: date-time + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + updated_at: + type: string + format: date-time + readOnly: true + date_format: + type: string + enum: + - mm/dd/yyyy + - mm-dd-yyyy + - dd/mm/yyyy + - dd-mm-yyyy + - yyyy/mm/dd + - yyyy-mm-dd + selectable_status: + type: string + risk_score_setting: + type: string + risk_type: + type: string + ownership_driver: + type: boolean + allow_multiple_selections: + type: boolean + filtered_by_ne_attribute: + type: boolean + filtering_ne_attribute_id: + type: string + format: uuid + ne_attribute_filter_id: + type: string + format: uuid + reverse_association_attribute_id: + type: string + format: uuid + profile_type_id: + type: string + format: uuid + legacy_id: + type: integer + tmp_created_at: + type: string + format: date-time + readOnly: true + tmp_updated_at: + type: string + format: date-time + readOnly: true + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/ne_attributes/{id}': + get: + summary: Find attribute data by id + operationId: getAttribute + description: Info for a specific attribute + tags: + - attributes + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + ne_attribute: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + description: + type: string + tool_tip: + type: string + crypt: + type: boolean + archived: + type: boolean + archived_on: + type: string + format: date-time + readOnly: true + created_at: + type: string + format: date-time + readOnly: true + updated_at: + type: string + format: date-time + readOnly: true + date_format: + type: string + enum: + - mm/dd/yyyy + - mm-dd-yyyy + - dd/mm/yyyy + - dd-mm-yyyy + - yyyy/mm/dd + - yyyy-mm-dd + selectable_status: + type: string + risk_score_setting: + type: string + risk_type: + type: string + ownership_driver: + type: boolean + allow_multiple_selections: + type: boolean + filtered_by_ne_attribute: + type: boolean + filtering_ne_attribute_id: + type: string + format: uuid + ne_attribute_filter_id: + type: string + format: uuid + reverse_association_attribute_id: + type: string + format: uuid + profile_type_id: + type: string + format: uuid + legacy_id: + type: integer + tmp_created_at: + type: string + format: date-time + readOnly: true + tmp_updated_at: + type: string + format: date-time + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /ne_attribute_option: + post: + summary: Add a value to an option based attribute + operationId: postAttributeOption + description: Add a value to an option based attribute + tags: + - attribute options + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + properties: + ne_attribute_id: + type: string + format: uuid + option: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string + '405': + description: Invalid input + /ne_attribute_options: + get: + summary: Get option based attribute values + operationId: getAttributeOptions + description: Get option based attribute values + tags: + - attribute options + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: ne_attribute_id + in: query + description: ID of an attribute for filtering + required: false + schema: + type: string + format: uuid + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple new option based attribute values + operationId: postAttributeOptions + description: Create multiple new option based attribute values + tags: + - attribute options + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + type: object + properties: + ne_attribute_id: + type: string + format: uuid + option: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + ne_attribute_options: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple option based attribute values + operationId: patchAttributeOptions + description: Update multiple option based attribute values + tags: + - attribute options + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ne_attribute_options: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + option: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + ne_attribute_options: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/ne_attribute_options/{id}': + get: + summary: Find option based attribute value by id + operationId: getAttributeOption + description: Info for a specific option based attribute value + tags: + - attribute options + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a option based attribute value by id + operationId: patchAttributeOption + description: Update a option based attribute value by id + tags: + - attribute options + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + properties: + ne_attribute_id: + type: string + format: uuid + option: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + ne_attribute_option: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + ne_attribute_id: + type: string + format: uuid + option: + type: string + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + delete: + summary: Delete a option based attribute value by id + operationId: deleteAttributeOption + description: Delete a option based attribute value by id + tags: + - attribute options + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Confirmation of a deleted object + content: + application/json: + schema: + type: object + properties: + info: + type: string + default: 'The option ''{Option Value}'' has been deleted' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /pages/profile_pages: + post: + summary: Create a profile page + operationId: createProfilePage + description: Create a profile page + tags: + - pages + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + page: + type: object + properties: + uid: + type: string + description: The uid of the page + example: page_uid + description: + type: text + example: Page for workflow + description: The description of the page + name: + type: string + example: My Page Name + description: The name of the page + archived: + type: boolean + example: false + description: Determines whether the page is archived + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + page: + type: object + properties: + uid: + type: string + description: The uid of the page + example: page_uid + description: + type: text + example: Page for workflow + description: The description of the page + name: + type: string + example: My Page Name + description: The name of the page + archived: + type: boolean + example: false + description: Determines whether the page is archived + id: + type: string + format: uuid + readOnly: true + description: The id of the form + example: 2e06b876-f456-473d-bd65-b6435e0b6b2d + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /pages/workflow_pages: + post: + summary: Create a workflow page + operationId: createWorkflowPage + description: Create a workflow page + tags: + - pages + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + page: + type: object + properties: + uid: + type: string + description: The uid of the page + example: page_uid + description: + type: text + example: Page for workflow + description: The description of the page + name: + type: string + example: My Page Name + description: The name of the page + archived: + type: boolean + example: false + description: Determines whether the page is archived + id: + type: string + format: uuid + readOnly: true + description: The id of the form + example: 2e06b876-f456-473d-bd65-b6435e0b6b2d + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + page: + type: object + properties: + uid: + type: string + description: The uid of the page + example: page_uid + description: + type: text + example: Page for workflow + description: The description of the page + name: + type: string + example: My Page Name + description: The name of the page + archived: + type: boolean + example: false + description: Determines whether the page is archived + id: + type: string + format: uuid + readOnly: true + description: The id of the form + example: 2e06b876-f456-473d-bd65-b6435e0b6b2d + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /profile_type: + post: + summary: Create a profile type + operationId: postProfileType + description: Create a profile type + tags: + - profile types + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + properties: + name: + type: string + bypass_dup_protection: + type: boolean + default: false + archived: + type: boolean + default: false + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /profile_types: + get: + summary: Get profile types + operationId: getProfileTypes + description: Get option based attribute values + tags: + - profile types + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: name + in: query + description: object name for filtering + required: false + schema: + type: string + - name: archived + in: query + description: Filter by archive status + required: false + schema: + type: boolean + default: false + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile_types: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/profile_types/{id}': + get: + summary: Find profile type by id + operationId: getProfileType + description: Find profile type by id + tags: + - profile types + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a profile type by id + operationId: patchProfileType + description: Update a profile type by id + tags: + - profile types + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + properties: + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile_type: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + bypass_dup_protection: + type: boolean + archived: + type: boolean + permitted_role_ids: + type: array + items: + type: string + format: uuid + profile_type_dup_attributes: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + profile_type_namings: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + uid: + type: string + minLength: 32 + maxLength: 32 + profile_type_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + order: + type: integer + minimum: 0 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + delete: + summary: Delete profile type + operationId: deleteProfileType + description: Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. + tags: + - profile types + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Info about the operation + content: + application/json: + schema: + type: object + properties: + info: + description: A message confirming the operation + example: object deleted + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /profile_type_roles: + post: + summary: Create a profile type role + description: This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type + operationId: createProfileTypeRole + tags: + - profile type roles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + form: + type: object + properties: + profile_type_id: + type: string + description: The id of the profile type + example: 2eb5773f-2486-452f-bdb3-796133b30862 + role_id: + type: string + description: The id of the role + example: 2eb5773f-2486-452f-bdb3-796133b30862 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + form: + type: object + properties: + profile_type_id: + type: string + description: The id of the profile type + example: 2eb5773f-2486-452f-bdb3-796133b30862 + role_id: + type: string + description: The id of the role + example: 2eb5773f-2486-452f-bdb3-796133b30862 + id: + type: string + description: The id of the profile type role + example: 2e06b876-f456-473d-bd65-b6435e0b6b2d + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /profile: + post: + summary: Create a profile + operationId: postProfile + description: Create a profile + tags: + - profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profile: + type: object + properties: + name: + type: string + profile_type_id: + type: string + format: uuid + required: true + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + required: true + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + archived: + type: boolean + default: false + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /profiles: + get: + summary: Get profiles + operationId: getProfiles + description: Get profiles + tags: + - profiles + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: exclude_attributes + in: query + description: Allows for optimization by not returning the associated attribute data for the returned profiles + required: false + schema: + type: boolean + default: false + - name: name + in: query + description: object name for filtering + required: false + schema: + type: string + - name: profile_type_id + in: query + description: Profile Type ID for filtering + required: false + schema: + type: string + format: uuid + - name: status + in: query + description: status value for filtering + required: false + schema: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple profiles + operationId: postProfiles + description: Create multiple profiles + tags: + - profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + name: + type: string + profile_type_id: + type: string + format: uuid + required: true + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + required: true + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + archived: + type: boolean + default: false + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple profiles + operationId: patchProfiles + description: Update multiple profiles + tags: + - profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + archived: + type: boolean + default: false + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + delete: + summary: Delete multiple profiles + operationId: deleteProfiles + description: Delete multiple profiles + tags: + - profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/profiles/{id}': + get: + summary: Find profile by id + operationId: getProfile + description: Find profile by id + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a profile by id + operationId: patchProfile + description: Update a profile by id + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + profile: + type: object + properties: + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + archived: + type: boolean + default: false + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + delete: + summary: Delete a single profile + operationId: deleteProfile + description: Delete a single profile + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '204': + description: The Profile was successfully deleted. + '400': + description: Error deleting Profile + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error that occurred + type: string + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/profiles/{id}/upload/{attribute_id}': + get: + summary: Retrieves the URL of an attachment attribute value from a profile + operationId: getProfileUpload + description: Retrieves the URL of an attachment attribute value from a profile + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + - name: attribute_id + in: path + description: The id of the attachment attribute + required: true + schema: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Uploads a new attachment attribute value to a profile + operationId: postProfileUpload + description: Uploads a new attachment attribute value to a profile + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + - name: attribute_id + in: path + description: The id of the attachment attribute + required: true + schema: + type: string + format: uuid + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/profiles/{id}/avatar': + get: + summary: Retrieves the URL of the profile avatar + operationId: getProfileAvatar + description: Retrieves the URL of the profile avatar + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Uploads a new profile avatar + operationId: postProfileAvatar + description: Uploads a new profile avatar + tags: + - profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /risk_scores: + get: + summary: Get risk score data in bulk + operationId: getRiskScores + description: This endpoint can retrieve risk score data in bulk from Lifecycle + tags: + - risk scores + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: object_id + in: query + description: ID of an object for filtering. Used along with object_type + required: false + schema: + type: string + format: uuid + - name: object_type + in: query + description: Type of object that object_id represents + required: false + schema: + type: string + enum: + - Profile + - WorkflowSession + - name: overall_risk_level_id + in: query + description: Overall risk level to filter by + required: false + schema: + type: string + format: uuid + - name: impact_risk_level_id + in: query + description: Impact risk level to filter by + required: false + schema: + type: string + format: uuid + - name: probability_risk_level_id + in: query + description: Probability risk level to filter by + required: false + schema: + type: string + format: uuid + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + risk_scores: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + object_id: + type: string + format: uuid + object_type: + type: string + enum: + - Profile + - WorkflowSession + overall_score: + type: number + multipleOf: 0.01 + overall_risk_level_id: + type: string + format: uuid + impact_score: + type: number + multipleOf: 0.01 + impact_risk_level_id: + type: string + format: uuid + probability_score: + type: number + multipleOf: 0.01 + probability_risk_level_id: + type: string + format: uuid + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/risk_scores/{id}': + get: + summary: Find risk score data by id + operationId: getRiskScore + description: Find risk score data by id + tags: + - risk scores + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + risk_score: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + object_id: + type: string + format: uuid + object_type: + type: string + enum: + - Profile + - WorkflowSession + overall_score: + type: number + multipleOf: 0.01 + overall_risk_level_id: + type: string + format: uuid + impact_score: + type: number + multipleOf: 0.01 + impact_risk_level_id: + type: string + format: uuid + probability_score: + type: number + multipleOf: 0.01 + probability_risk_level_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /risk_levels: + get: + summary: Get risk level data in bulk + operationId: getRiskLevels + description: This endpoint can retrieve risk level data in bulk from Lifecycle + tags: + - risk levels + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: label + in: query + description: The attribute label to filter by + required: false + schema: + type: string + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + risk_levels: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + points: + type: number + multipleOf: 0.01 + order: + type: integer + minimum: 0 + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/risk_levels/{id}': + get: + summary: Find risk level data by id + operationId: getRiskLevel + description: Find risk level data by id + tags: + - risk levels + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + risk_level: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + points: + type: number + multipleOf: 0.01 + order: + type: integer + minimum: 0 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /user_profile: + post: + summary: Create a user-profile contributor relationship + operationId: postUserProfile + description: Create a user-profile contributor relationship + tags: + - user profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + properties: + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + '405': + description: Invalid input + /user_profiles: + get: + summary: Get user-profile contributor relationships + operationId: getUserProfiles + description: Get user-profile contributor relationships + tags: + - user profiles + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: user_id + in: query + description: The ID of a user for filtering + required: false + schema: + type: string + format: uuid + example: bba9cfb2-96c1-4acb-ac79-a21732527265 + - name: ne_attribute_id + in: query + description: ID of an attribute for filtering + required: false + schema: + type: string + format: uuid + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + - name: profile_id + in: query + description: Profile ID to filter by + required: false + schema: + type: string + format: uuid + example: 4e480441-451d-47d9-87c2-9a0f0fe135eb + - name: relationship_type + in: query + description: Type of user contributor relationship to filter by + required: false + schema: + type: string + enum: + - owner + - contributor + example: contributor + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple user-profile contributor relationships + operationId: createUserProfiles + description: Create multiple user-profile contributor relationships + tags: + - user profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple user-profile contributor relationships + operationId: patchUserProfiles + description: Update multiple user-profile contributor relationships + tags: + - user profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + delete: + summary: Delete multiple user-profile contributor relationships + operationId: deleteUserProfiles + description: Delete multiple user-profile contributor relationships + tags: + - user profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + user_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/user_profiles/{id}': + get: + summary: Find user-profile contributor relationship by id + operationId: getUserProfile + description: Find user-profile contributor relationship by id + tags: + - user profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a user-profile contributor relationship by id + operationId: patchUserProfile + description: Update a user-profile contributor relationship by id + tags: + - user profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + properties: + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + user_profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + user_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + ne_attribute_id: + type: string + format: uuid + relationship_type: + type: string + enum: + - owner + - contributor + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/user_profile/{id}': + delete: + summary: Delete a user profile assignment + operationId: deleteUserProfile + description: Delete a user profile assignment + tags: + - user profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: User profile was destroyed + content: + application/json: + schema: + type: object + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /role_profile: + post: + summary: Create a role-profile contributor relationship + operationId: postRoleProfile + description: Create a role-profile contributor relationship + tags: + - role profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + properties: + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + '405': + description: Invalid input + /role_profiles: + get: + summary: Get role-profile contributor relationships + operationId: getRoleProfiles + description: Get role-profile contributor relationships + tags: + - role profiles + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: role_id + in: query + description: The ID of a role for filtering + required: false + schema: + type: string + format: uuid + - name: profile_id + in: query + description: Profile ID to filter by + required: false + schema: + type: string + format: uuid + example: 4e480441-451d-47d9-87c2-9a0f0fe135eb + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create multiple role-profile contributor relationships + operationId: postRoleProfiles + description: Create multiple role-profile contributor relationships + tags: + - role profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + type: object + properties: + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + role_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update multiple role-profile contributor relationships + operationId: patchRoleProfiles + description: Update multiple role-profile contributor relationships + tags: + - role profiles + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - type: object + properties: + role_profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + - type: object + properties: + info: + type: string + example: job has started + job_status: + type: object + properties: + job_id: + type: string + example: 3ce88e47ad6dba2ddf349d21 + status: + type: string + example: queued + status: + type: int + example: 200 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/role_profiles/{id}': + get: + summary: Find role-profile contributor relationship by id + operationId: getRoleProfile + description: Find role-profile contributor relationship by id + tags: + - role profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a role-profile contributor relationship by id + operationId: patchRoleProfile + description: Update a role-profile contributor relationship by id + tags: + - role profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + properties: + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + role_profile: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + role_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/role_profile/{id}': + delete: + summary: Delete a role profile assignment + operationId: deleteRoleProfile + description: Delete a role profile assignment + tags: + - role profiles + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Role profile was destroyed + content: + application/json: + schema: + type: object + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/create_workflows: + post: + summary: Create a create workflow + operationId: createCreateWorkflow + description: Create a create workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/update_workflows: + post: + summary: Create an update workflow + operationId: createUpdateWorkflow + description: Create an update workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + profile_status: + type: string + required: true + description: The status of the profiles the workflow will effect. + example: active + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/batch_workflows: + post: + summary: Create a batch workflow + operationId: createBatchWorkflow + description: Create a batch workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + options: + type: object + properties: + all_profiles: + type: string + enum: + - 'true' + - 'false' + description: Used for batch workflows. + example: true + multiple_requests: + type: string + enum: + - 'true' + - 'false' + description: Used for batch workflows for if multiple requests. + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/automated_workflows: + post: + summary: Create an automated workflow + operationId: createAutomatedWorkflow + description: Create an automated workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + condition_rules_attributes: + type: array + items: + type: object + properties: + logical_operator: + type: string + enum: + - AND + - OR + required: true + description: The type of condition rule. + example: RiskRule + comparison_operator: + type: string + enum: + - < + - '>' + - '==' + - before + - include? + - absent? + - after + required: true + description: The operator used by the condition rule. + example: '>' + condition_object_id: + type: string + required: false + description: UUID for object targeted by the condition. + example: cc844e99-9895-43d0-9d17-8f606b2158ba + condition_object_type: + type: string + required: false + description: Type of object targeted by the condition. + example: DateAttribute + secondary_value: + type: string + required: false + description: Used for time_frame comparison. + example: before + tertiary_value: + type: string + required: false + description: Represents the days of a temporal comparison. + example: before + value: + type: string + required: false + description: The value being compared against. + example: before + order: + type: integer + format: int32 + required: false + description: 'If there are multiple rules against one workflow, this is the order that they are ran in.' + example: 1 + type: + type: string + enum: + - RiskRule + - ProfileIdRule + - ProfileTypeRule + - ProfileExistsRule + - ProfileStatusRule + - SessionAttributeRule + - ProfileAttributeRule + - ProfileDoesNotExistRule + - IdentityProofingRule + required: true + description: The type of condition rule. + example: ProfileIdRule + description: The ProfileTypeRule this workflow will be working with. + example: + - type: ProfileTypeRule + condition_type: Workflow + comparison_operator: '==' + logical_operator: AND + value: 'true' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/registration_workflows: + post: + summary: Create a registration workflow + operationId: createRegistrationWorkflow + description: Create a registration workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/login_workflows: + post: + summary: Create a login workflow + operationId: createLoginWorkflow + description: Create a login workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + options: + type: object + properties: + expiration_time: + type: integer + format: int32 + minimum: 1 + description: Used for login/password reset for when the password will expire. + example: 1 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflows/password_reset_workflows: + post: + summary: Create a password reset workflow + operationId: createPasswordUpdateWorkflow + description: Create a password reset workflow + tags: + - workflows + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + profile_type_id: + type: string + format: uuid + required: true + description: The profile type the workflow effects. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + status: + type: string + enum: + - Enabled + - Disabled + required: true + description: Whether or not the workflow is enabled or disabled. + example: Enabled + uid: + type: string + required: true + description: The uid of the workflow. + example: my_uid + name: + type: string + required: true + description: Name of the workflow + example: my_workflow + options: + type: object + properties: + expiration_time: + type: integer + format: int32 + minimum: 1 + description: Used for login/password reset for when the password will expire. + example: 1 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/approval_actions: + post: + summary: Create an approval action + operationId: createApprovalAction + description: 'Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/ask_security_question_actions: + post: + summary: Create ask security question action + operationId: createAskSecurityQuestionAction + description: Create an ask security question action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user to answer some personal security questions. + number_of_questions: + type: integer + format: int32 + required: true + description: The number of questions the user should answer upon login. + example: 1 + token_expiration: + type: integer + format: int32 + required: true + description: 'The token expiration time, coordinates with token_expiration_type.' + example: 1 + token_expiration_type: + type: string + required: true + enum: + - hours + - days + - login attempts + - always + description: 'The token expiration type, coordinates with token_expiration.' + example: days + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/auto_assign_actions: + post: + summary: Create an auto assign action + operationId: createAutoAssignAction + description: 'Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Automatically assigns contributors to this profile. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + contributor_attr: + type: string + format: uuid + required: false + description: 'The id of the contributor attribute for contributors from another profile. If workflow_action_roles are not associated to this object, this is required.' + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/batch_update_actions: + post: + summary: Create a batch update action + operationId: createBatchUpdateAction + description: Create a batch update action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Updates a batch of profiles with all attributes collected during the workflow. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/close_session_actions: + post: + summary: Create a close session action + operationId: createCloseSessionAction + description: Create a close session action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Closes the current workflow session. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/contributors_actions: + post: + summary: Create a contributors action + operationId: createContributorsAction + description: 'Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have the requester determine the contributors or owner of the profile. + owner: + type: string + required: false + enum: + - true + - false + description: 'If the assignment option should be an owner. Owner, Contributors, or Roles must be chosen.' + example: 'true' + contributors: + type: string + required: false + enum: + - true + - false + description: 'If the assignment option should be contributors. Owner, Contributors, or Roles must be chosen.' + example: 'true' + roles: + type: string + required: false + enum: + - true + - false + description: 'If the assignment option should be roles. Owner, Contributors, or Roles must be chosen.' + example: 'true' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/create_profile_actions: + post: + summary: Create a create profile action + operationId: createCreateProfileAction + description: Create a create profile action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Creates a profile with all attributes collected during the workflow. + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/duplicate_prevention_actions: + post: + summary: Create a duplicate prevention action + operationId: createDuplicatePreventionAction + description: 'Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: 'Allows a user to select an already existing profile, or create a new one for the request.' + search_scope: + type: string + required: true + enum: + - all + - current + description: The search scope of the profiles to check against. + example: current + ne_attribute_ids: + type: array + required: false + description: An array of ne_attribute_ids. + example: + - 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + handle_id: + type: string + required: false + description: The handle id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/email_verification_actions: + post: + summary: Create an email verification action + operationId: createEmailVerificationAction + description: Create an email verification action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have the user verify their email address. + email_expiration: + type: integer + format: int32 + required: true + description: 'The email expiration time, in minutes.' + example: 20 + token_expiration: + type: integer + format: int32 + required: true + description: 'The token expiration time, coordinates with token_expiration_type.' + example: 1 + token_expiration_type: + type: string + required: true + enum: + - hours + - days + - login attempts + - always + description: 'The token expiration type, coordinates with token_expiration.' + example: days + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/fulfillment_actions: + post: + summary: Create a fulfillment action + operationId: createFulfillmentAction + description: 'Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have another user or group provide information for the profile. + page_id: + type: string + format: uuid + required: false + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/identity_proofing_actions: + post: + summary: Create an identity proofing action + operationId: createIdentityProofingAction + description: 'Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Have the user account associated with this profile validate the identity data. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/invitation_actions: + post: + summary: Create an invitation action + operationId: createInvitationAction + description: 'Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Creates a registration session associated with an email address + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + configuration_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + wait_for_completion: + type: boolean + example: false + description: If the invitation action should pause the parent workflow to wait for completion. + return_profile: + type: boolean + example: false + description: If the invitation action should return a profile. + portal_id: + type: string + format: uuid + description: the id of the portal. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + registration_workflow_id: + type: string + format: uuid + description: the id of the registration workflow. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_attribute_id: + type: string + format: uuid + description: the id of the email attribute. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + validate_completed_registration: + type: boolean + example: false + description: If the action should validate against completed registrations by email address. + validate_open_registration: + type: boolean + example: false + description: If the action should validate against open registrations by email address. + workflow_action_email_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_id: + type: string + format: uuid + description: the id of the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_id: + type: string + format: uuid + description: the id of the email. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + type: + type: string + description: the type of email. + enum: + - StandardEmail + - PerformerNotificationEmail + - ApprovalEmail + - RejectionEmail + example: StandardEmail + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/ldap_actions: + post: + summary: Create a ldap action + operationId: createLdapAction + description: 'Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Create a Collaboration user account for this profile. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + store_type: + type: string + required: true + enum: + - Local + - Directory + description: the type of store. + example: Local + ldap_action_user_roles_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + role_id: + type: string + format: uuid + description: the id of the role. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_value_builders_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_id: + type: string + format: uuid + description: the id of the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + value_builder_id: + type: string + format: uuid + description: the id of the value builder. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + position: + type: integer + format: int32 + description: the position of the value builder attribute. + example: 1 + workflow_action_directory_groups_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + directory_id: + type: string + format: uuid + description: the id of the directory. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + group_label: + type: string + format: text + description: the group label. + example: Admin + group_dn: + type: string + format: text + description: the group dn. + example: group + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/notification_actions: + post: + summary: Create a notification action + operationId: createNotificationAction + description: Create a notification action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Send a notification to a group of users. + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + workflow_action_email_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_action_id: + type: string + format: uuid + description: the id of the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_id: + type: string + format: uuid + description: the id of the email. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + type: + type: string + enum: + - StandardEmail + description: the type of email. + example: StandardEmail + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/password_reset_actions: + post: + summary: Create a password reset action + operationId: createPasswordResetAction + description: Create a password reset action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user to reset their password. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/profile_check_actions: + post: + summary: Create a profile check action + operationId: createProfileCheckAction + description: Create a profile check action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Finds a profile based on selected attributes and values found in the session. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + ne_attribute_ids: + type: array + required: false + description: An array of ne_attribute_ids. + example: + - 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + handle_type: + type: string + required: false + enum: + - session + - attribute + description: The handle type for what should happen if an existing profile is found. + example: session + handle_id: + type: string + required: false + description: 'The handle id. When handle type is session, this is the session id.' + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/profile_select_actions: + post: + summary: Create a profile select action + operationId: createProfileSelectAction + description: Create a profile select action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Select the profiles that you want to run this workflow for. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/request_actions: + post: + summary: Create a request action + operationId: createRequestAction + description: Create a request action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Provides the requester a page with forms. + page_id: + type: string + format: uuid + required: false + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/rest_api_actions: + post: + summary: Create a REST API action + operationId: createRestApiAction + description: 'Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Makes a request to a Restful API. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/review_actions: + post: + summary: Create a review action + operationId: createReviewAction + description: 'Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Allows the requester to review. + page_id: + type: string + format: uuid + required: false + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/run_workflow_actions: + post: + summary: Create a run workflow action + operationId: createRunWorkflowAction + description: 'Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Runs another workflow with the ability to pass data in between. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + configuration_attributes: + type: object + properties: + id: + type: string + format: uuid + description: the id. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + workflow_id: + type: string + format: uuid + description: the id of the workflow. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + wait_for_completion: + type: boolean + description: If the parent workflow should wait for the child to complete. + example: false + profile_to_send: + type: string + enum: + - none + - current + - attribute + - profile_type + description: the profile the parent should send to the child workflow. + example: current + return_profile: + type: boolean + description: if the child workflow should return a profile. + example: false + run_workflow_action_id: + type: string + format: uuid + description: the id of the child workflow to run. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + profile_type_id: + type: string + format: uuid + description: the id of the profile type. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/set_attributes_actions: + post: + summary: Create a set attributes action + operationId: createSetAttributesAction + description: 'Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Set attribute(s) to a specific value. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/set_security_question_actions: + post: + summary: Create set security question action + operationId: createSetSecurityQuestionAction + description: Create a set security question action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user to provide some personal security questions and answers. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + number_of_questions: + type: integer + format: int32 + required: true + description: The number of questions the user should answer upon login. + example: 1 + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/soap_api_actions: + post: + summary: Create a SOAP API action + operationId: createSoapApiAction + description: 'Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Makes a request to a SOAP API. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/status_change_actions: + post: + summary: Create a status change action + operationId: createStatusChangeAction + description: Create a status change action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Changes the status of a non-employee. + new_status: + type: string + format: text + required: false + enum: + - Active + - Inactive + - On Leave + - Terminated + description: The new status for the Status Change workflow action. + example: Active + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/unassign_actions: + post: + summary: Create an unassign action + operationId: createUnassignAction + description: 'Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).' + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Un-assigns roles from a profile. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/update_profile_actions: + post: + summary: Create an update profile action + operationId: createUpdateProfileAction + description: Create an update profile action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Updates a profile with all attributes collected during the workflow. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_actions/username_password_actions: + post: + summary: Create a username password action + operationId: createUsernamePasswordAction + description: Create a username password action + tags: + - workflow actions + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: true + description: The description of the workflow action. + example: Prompt the user for their username and password. + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_action: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + description: The workflow the workflow action belongs to. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + description: + type: string + required: false + description: The description of the workflow action. + example: Require approval from another user or a group of users with a specific role. + page_id: + type: string + format: uuid + required: true + description: The page the workflow action should render. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + add_requester_as_owner: + type: boolean + default: true + description: If the requester should be added as the owner of the profile to be created. + example: true + email_attribute_id: + type: string + format: uuid + required: false + description: The attribute storing the email address for the workflow action. + example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8 + email_addresses: + type: array + required: false + items: + type: string + format: text + description: The email addresses for the workflow action. + example: + - johndoe@gmail.com + - janedoe@gmail.com + new_status: + type: string + format: text + required: false + description: The new status for the Status Change workflow action. + example: 'Active, Inactive, On Leave, Terminated' + archived: + type: boolean + default: false + description: If the workflow action is archived or not. + example: false + skippable: + type: boolean + default: false + description: If the workflow action is skippable or not. + example: false + requires_comment: + type: boolean + default: false + description: If the workflow action requires a comment or not. + example: false + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /workflow_sessions: + get: + summary: Get workflow sessions + operationId: getWorkflowSessions + description: Get workflow sessions + tags: + - workflow sessions + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: profile_id + in: query + description: Profile ID to filter by + required: false + schema: + type: string + format: uuid + example: 4e480441-451d-47d9-87c2-9a0f0fe135eb + - name: uid + in: query + description: Workflow session uid for filtering + required: false + schema: + type: string + minLength: 32 + maxLength: 32 + - name: workflow_id + in: query + description: Workflow ID for filtering + required: false + schema: + type: string + format: uuid + - name: requester_id + in: query + description: Requester ID for filtering + required: false + schema: + type: string + format: uuid + - name: status + in: query + description: filter by workflow session status + required: false + schema: + type: string + enum: + - waiting on workflow + - identity proofing completed + - new + - closing + - pending request + - requested + - pending approval + - approved + - pending notification + - notified + - pending review + - reviewed + - pending trigger + - stored procedure + - pending status change + - status changed + - pending update + - non employee updated + - non employee created + - pending creation + - rejected + - pending assignment + - assigned + - default + - failed + - un assigned + - auto assigned + - ldap provided + - pending ldap + - pending fulfillment + - pending stored procedure + - pending courion add + - fulfilled + - pending courion update + - courion add + - pending courion_extend + - courion update + - pending courion terminate + - courion extend + - pending profile select + - courion terminate + - batch completed + - profiles selected + - answered questions + - pending questions + - attempting to start workflow + - started workflow + - profile check complete + - completed + - processing + - pending set attribute + - invitation sent + - action skipped + - api request sent + - attribute set + - disabled + - duplicates resolved + - soap request sent + - checking for duplicates + - pending identity proofing + - closed + - workflow changed + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_sessions: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Create a workflow session + operationId: postWorkflowSession + description: Create a workflow session + tags: + - workflow sessions + parameters: + - name: run + in: query + description: Will run the created/updated workflow session if successful + required: false + schema: + type: boolean + default: false + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + properties: + workflow_id: + type: string + format: uuid + required: true + requester_id: + type: string + format: uuid + required: true + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + required: true + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/workflow_sessions/{id}': + get: + summary: Find workflow session by id + operationId: getWorkflowSession + description: Find workflow session by id + tags: + - workflow sessions + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + patch: + summary: Update a workflow session by id + operationId: patchWorkflowSession + description: Update a workflow session by id + tags: + - workflow sessions + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + - name: run + in: query + description: Will run the created/updated workflow session if successful + required: false + schema: + type: boolean + default: false + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + properties: + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + workflow_session: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + workflow_id: + type: string + format: uuid + requester_id: + type: string + format: uuid + requester_type: + type: string + enum: + - User + - NeprofileUser + - NeaccessUser + profile_id: + type: string + format: uuid + description: The profile this workflow session will be working with. Only Applicable for Update workflows + profile_ids: + type: array + items: + type: string + format: uuid + description: The profiles this workflow session will be working with. Only Applicable for Batch workflows + status: + type: string + enum: + - api_request_sent + - approved + - assigned + - attempting_to_start_workflow + - AUTH-STATUS1 + - AUTH-STATUS2 + - AUTH-STATUS3 + - AUTH-STATUS4 + - AUTH-STATUS5 + - AUTH-STATUS6 + - AUTH-STATUS7 + - AUTH-STATUS8 + - AUTH-STATUS9 + - auto_assigned + - batch_completed + - checking_for_duplicates + - closed + - completed + - courion_add + - courion_extend + - courion_terminate + - courion_update + - duplicates_resolved + - failed + - fulfilled + - invitation_sent + - ldap_provided + - new + - non_employee_created + - non_employee_updated + - notified + - pending_approval + - pending_assignment + - pending_courion_add + - pending_courion_extend + - pending_courion_terminate + - pending_courion_update + - pending_creation + - pending_fulfillment + - pending_ldap + - pending_notification + - pending_profile_select + - pending_request + - pending_review + - pending_status_change + - pending_stored_procedure + - pending_trigger + - pending_update + - processing + - profile_check_complete + - profiles_selected + - rejected + - requested + - reviewed + - soap_request_sent + - started_workflow + - status_changed + - stored_procedure + - un_assigned + - waiting_on_workflow + - workflow_changed + example: completed + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + '/workflow_sessions/{id}/upload/{attribute_id}': + get: + summary: Retrieves the URL of an attachment attribute value from a workflow session + operationId: getWorkflowSessionUpload + description: Retrieves the URL of an attachment attribute value from a workflow session + tags: + - workflow sessions + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + - name: attribute_id + in: path + description: The id of the attachment attribute + required: true + schema: + type: string + format: uuid + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + post: + summary: Uploads a new attachment attribute value to a workflow session + operationId: postWorkflowSessionUpload + description: Uploads a new attachment attribute value to a workflow session + tags: + - workflow sessions + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + - name: attribute_id + in: path + description: The id of the attachment attribute + required: true + schema: + type: string + format: uuid + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + url: + type: string + format: url + readOnly: true + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /identity_proofing_results: + get: + summary: Get identity proofing result data in bulk + operationId: getIdentityProofingResults + description: This endpoint can retrieve identity proofing result data in bulk from Lifecycle + tags: + - identity proofing results + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + - name: profile_id + in: query + description: Profile ID to filter by + required: false + schema: + type: string + format: uuid + example: 4e480441-451d-47d9-87c2-9a0f0fe135eb + - name: workflow_session_id + in: query + description: Workflow Session ID to filter by + required: false + schema: + type: string + format: uuid + - name: result + in: query + description: ID Proofing Result to filter by + required: false + schema: + type: string + enum: + - pass + - fail + - name: metadata + in: query + description: Returns batching metadata in the response + required: false + schema: + type: boolean + default: false + example: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + identity_proofing_results: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + identity_proofing_action_id: + type: string + format: uuid + workflow_session_id: + type: string + format: uuid + profile_id: + type: string + format: uuid + proofing_workflow: + type: string + format: uuid + result: + type: string + enum: + - pending + - pass + - fail + proofing_attributes: + type: object + additionalProperties: + type: string + example: + result: approve + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + _metadata: + type: object + properties: + limit: + type: integer + offset: + type: integer + total: + type: integer + next: + type: string + example: /endpoint?limit=10&offset=60 + previous: + type: string + example: /endpoint?limit=10&offset=40 + /advanced_search: + get: + summary: Get saved advanced search queries + operationId: getAdvancedSearch + description: Get saved advanced search queries + tags: + - advanced search + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + advanced_search: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileTypeRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + format: uuid + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileStatusRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + enum: + - Active + - Inactive + - Leave of absence + - Terminated + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - TextFieldAttribute + - TextAreaAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + - '>' + - < + - start_with? + - end_with? + - include? + value: + type: string + required: true + example: Some value + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - DateAttribute + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: + - DateAttribute + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: + - '>' + - < + - after + - before + value: + type: string + required: true + enum: + - Today + - + secondary_value: + type: string + enum: + - after + - before + tertiary_value: + type: string + example: 30 + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - ProfileSelectAttribute + - ProfileSearchAttribute + - OwnerSelectAttribute + - OwnerSearchAttribute + - ContributorSelectAttribute + - ContributorSearchAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - include? + - exclude? + value: + type: string + required: true + format: uuid + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - RiskRule + comparison_operator: + type: string + enum: + - '==' + - '>' + - < + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: + - OverallRisk + post: + summary: Save an advanced search query for later use + operationId: postAdvancedSearch + description: Save an advanced search query for later use + tags: + - advanced search + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + properties: + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileTypeRule + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + value: + type: string + required: true + format: uuid + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileStatusRule + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + value: + type: string + required: true + enum: + - Active + - Inactive + - Leave of absence + - Terminated + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - TextFieldAttribute + - TextAreaAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + - '>' + - < + - start_with? + - end_with? + - include? + value: + type: string + required: true + example: Some value + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - DateAttribute + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: + - DateAttribute + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: + - '>' + - < + - after + - before + value: + type: string + required: true + enum: + - Today + - + secondary_value: + type: string + enum: + - after + - before + tertiary_value: + type: string + example: 30 + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - ProfileSelectAttribute + - ProfileSearchAttribute + - OwnerSelectAttribute + - OwnerSearchAttribute + - ContributorSelectAttribute + - ContributorSearchAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - include? + - exclude? + value: + type: string + required: true + format: uuid + - type: object + properties: + type: + type: string + required: true + enum: + - RiskRule + comparison_operator: + type: string + enum: + - '==' + - '>' + - < + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: + - OverallRisk + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileTypeRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + format: uuid + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileStatusRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + enum: + - Active + - Inactive + - Leave of absence + - Terminated + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - TextFieldAttribute + - TextAreaAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + - '>' + - < + - start_with? + - end_with? + - include? + value: + type: string + required: true + example: Some value + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - DateAttribute + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: + - DateAttribute + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: + - '>' + - < + - after + - before + value: + type: string + required: true + enum: + - Today + - + secondary_value: + type: string + enum: + - after + - before + tertiary_value: + type: string + example: 30 + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - ProfileSelectAttribute + - ProfileSearchAttribute + - OwnerSelectAttribute + - OwnerSearchAttribute + - ContributorSelectAttribute + - ContributorSearchAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - include? + - exclude? + value: + type: string + required: true + format: uuid + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - RiskRule + comparison_operator: + type: string + enum: + - '==' + - '>' + - < + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: + - OverallRisk + /advanced_search/run: + post: + summary: 'Run an advanced search for profiles, without saving the query' + operationId: runAdvancedSearch + description: 'Run an advanced search for profiles, without saving the query' + tags: + - advanced search + parameters: + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + properties: + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileTypeRule + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + value: + type: string + required: true + format: uuid + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileStatusRule + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + value: + type: string + required: true + enum: + - Active + - Inactive + - Leave of absence + - Terminated + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - TextFieldAttribute + - TextAreaAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + - '>' + - < + - start_with? + - end_with? + - include? + value: + type: string + required: true + example: Some value + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - DateAttribute + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: + - DateAttribute + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: + - '>' + - < + - after + - before + value: + type: string + required: true + enum: + - Today + - + secondary_value: + type: string + enum: + - after + - before + tertiary_value: + type: string + example: 30 + - type: object + properties: + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - ProfileSelectAttribute + - ProfileSearchAttribute + - OwnerSelectAttribute + - OwnerSearchAttribute + - ContributorSelectAttribute + - ContributorSearchAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - include? + - exclude? + value: + type: string + required: true + format: uuid + - type: object + properties: + type: + type: string + required: true + enum: + - RiskRule + comparison_operator: + type: string + enum: + - '==' + - '>' + - < + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: + - OverallRisk + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + '/advanced_search/{id}': + patch: + summary: Update a saved advanced search query + operationId: patchAdvancedSearch + description: Update a saved advanced search query + tags: + - advanced search + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + properties: + id: + type: string + format: uuid + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + type: + type: string + required: true + enum: + - ProfileTypeRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + format: uuid + _destroy: + type: boolean + default: false + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + type: + type: string + required: true + enum: + - ProfileStatusRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + enum: + - Active + - Inactive + - Leave of absence + - Terminated + _destroy: + type: boolean + default: false + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - TextFieldAttribute + - TextAreaAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + - '>' + - < + - start_with? + - end_with? + - include? + value: + type: string + required: true + example: Some value + _destroy: + type: boolean + default: false + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - DateAttribute + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: + - DateAttribute + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: + - '>' + - < + - after + - before + value: + type: string + required: true + enum: + - Today + - + secondary_value: + type: string + enum: + - after + - before + tertiary_value: + type: string + example: 30 + _destroy: + type: boolean + default: false + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - ProfileSelectAttribute + - ProfileSearchAttribute + - OwnerSelectAttribute + - OwnerSearchAttribute + - ContributorSelectAttribute + - ContributorSearchAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - include? + - exclude? + value: + type: string + required: true + format: uuid + _destroy: + type: boolean + default: false + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - RiskRule + comparison_operator: + type: string + enum: + - '==' + - '>' + - < + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: + - OverallRisk + _destroy: + type: boolean + default: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + advanced_search: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + label: + type: string + condition_rules_attributes: + type: array + items: + anyOf: + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileTypeRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + format: uuid + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileStatusRule + comparison_operator: + type: string + enum: + - '==' + - '!=' + value: + type: string + enum: + - Active + - Inactive + - Leave of absence + - Terminated + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - TextFieldAttribute + - TextAreaAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - '==' + - '!=' + - '>' + - < + - start_with? + - end_with? + - include? + value: + type: string + required: true + example: Some value + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - DateAttribute + condition_object_id: + type: string + format: uuid + secondary_attribute_type: + type: string + enum: + - DateAttribute + secondary_attribute_id: + type: string + format: uuid + comparison_operator: + type: string + enum: + - '>' + - < + - after + - before + value: + type: string + required: true + enum: + - Today + - + secondary_value: + type: string + enum: + - after + - before + tertiary_value: + type: string + example: 30 + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - ProfileAttributeRule + condition_object_type: + type: string + required: true + enum: + - ProfileSelectAttribute + - ProfileSearchAttribute + - OwnerSelectAttribute + - OwnerSearchAttribute + - ContributorSelectAttribute + - ContributorSearchAttribute + condition_object_id: + type: string + required: true + format: uuid + comparison_operator: + type: string + required: true + enum: + - include? + - exclude? + value: + type: string + required: true + format: uuid + - type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + type: + type: string + required: true + enum: + - RiskRule + comparison_operator: + type: string + enum: + - '==' + - '>' + - < + value: + type: string + summary: id of the Risk Level being compared against + required: true + format: uuid + secondary_value: + type: string + required: true + enum: + - OverallRisk + '/advanced_search/{id}/run': + get: + summary: Run a saved advanced search query + operationId: runAdvancedSearchbyID + description: Run a saved advanced search query + tags: + - advanced search + parameters: + - name: id + in: path + description: 'ID of the object to retrieve, update, or delete' + required: true + schema: + type: string + format: uuid + example: 1246d8b3-ac29-4015-8154-dea4434a73fa + - name: query + in: query + description: Allows for pagination and sorting. + required: false + schema: + type: object + properties: + limit: + type: integer + example: 100 + offset: + type: integer + example: 50 + order: + type: string + example: created_at + example: + limit: 100 + offset: 50 + order: created_at + style: deepObject + explode: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + profiles: + type: array + items: + type: object + properties: + id: + type: string + format: uuid + readOnly: true + uid: + type: string + minLength: 32 + maxLength: 32 + readOnly: true + name: + type: string + profile_type_id: + type: string + format: uuid + status: + type: string + enum: + - Active + - Inactive + - On Leave + - Terminated + id_proofing_status: + type: string + enum: + - pending + - pass + - fail + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + attributes: + type: object + additionalProperties: + type: string + example: + text_attribute_uid: static text + date_attribute_uid: 01/15/2020 + profile_select_attribute_uid: Profile Name + multiple_profile_select_attribute_uid: 'Profile Name,Second Profile Name,Third Profile Name' + contributor_select_attribute_uid: User Name + multiple_contributor_select_attribute_uid: 'User Name,Second User Name,Third User Name' + /job_status: + get: + summary: Get the status of a bulk job + operationId: getJobStatus + description: Get the status of a bulk job + tags: + - job status + parameters: + - name: job_id + in: query + description: The id of the job returned from a POST or PATCH endpoint that resulted in a job being created + required: true + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + uid: + type: string + format: uuid + status: + type: string + example: complete + job_type: + type: string + example: import + job_data: + type: array + items: + type: object + properties: + user_id: + type: string + format: uuid + manager_id: + type: string + format: uuid + errors: + type: array + items: + type: string + example: Validation error for record in job + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /forms: + post: + summary: Create a form + description: This endpoint can create a form + operationId: createForm + tags: + - forms + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + form: + type: object + properties: + uid: + type: string + description: The uid of the form + example: form_uid + description: + type: text + example: Form for creating new profile + description: The description of the form + name: + type: string + example: My Form Name + description: The name of the form + archived: + type: boolean + example: false + description: Determines whether the form is archived + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + form: + type: object + properties: + uid: + type: string + description: The uid of the form + example: form_uid + description: + type: text + example: Form for creating new profile + description: The description of the form + name: + type: string + example: My Form Name + description: The name of the form + archived: + type: boolean + example: false + description: Determines whether the form is archived + id: + type: string + format: uuid + readOnly: true + description: The id of the form + example: 2e06b876-f456-473d-bd65-b6435e0b6b2d + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong + /form_attributes: + post: + summary: Create a form attribute + description: This endpoint can create a form attribute + operationId: createFormAttribute + tags: + - form attributes + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + form_attribute: + type: object + properties: + form_id: + type: string + description: The id of the form + example: ac4aae0b-4140-49a4-a84c-126762fd0c8f + ne_attribute_id: + type: string + example: ac4aae0b-4140-49a4-a84c-126762fd0c8f + description: The id of the attribute + attr_type: + type: string + example: ne_attribute + description: The attribute type + enum: + - ne_attribute + - break + order: + type: integer + format: int32 + example: 1 + description: The position of the attribute on the form + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + properties: + form_attribute: + type: object + properties: + form_id: + type: string + description: The id of the form + example: ac4aae0b-4140-49a4-a84c-126762fd0c8f + ne_attribute_id: + type: string + example: ac4aae0b-4140-49a4-a84c-126762fd0c8f + description: The id of the attribute + attr_type: + type: string + example: ne_attribute + description: The attribute type + enum: + - ne_attribute + - break + order: + type: integer + format: int32 + example: 1 + description: The position of the attribute on the form + id: + type: string + example: ac4aae0b-4140-49a4-a84c-126762fd0c8f + description: The id of the form attribute + '400': + description: Bad Request - unable to complete. + content: + application/json: + schema: + oneOf: + - type: object + properties: + error: + example: Invalid JSON syntax. Please check your syntax and try again. + - type: object + properties: + error: + example: The failed to create/update + errors: + example: + attribute: can't be blank + '500': + description: Internal Server Error - returned on unhandled exceptions. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: Sorry something went wrong +security: + - bearerAuth: [] +components: + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: Token token=your token diff --git a/postman/collections/sailpoint-api-nerm.json b/postman/collections/sailpoint-api-nerm.json new file mode 100644 index 0000000..79e115e --- /dev/null +++ b/postman/collections/sailpoint-api-nerm.json @@ -0,0 +1,29491 @@ +{ + "item": [ + { + "name": "user", + "description": "", + "item": [ + { + "id": "dbbcddf3-8771-4484-b2dd-0ecc2f585574", + "name": "Create a new user", + "request": { + "name": "Create a new user", + "description": { + "content": "Create a new user", + "type": "text/plain" + }, + "url": { + "path": [ + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "09d57b4f-68a7-4a64-bc0a-ad66358713db", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b8866ff6-2d36-4e01-bf2c-ce9ef1054c10", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42eb18e3-9324-4460-b630-1750d1682692", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "users", + "description": "", + "item": [ + { + "id": "22b6e662-742b-46fb-b81d-39a449e9d838", + "name": "Get users", + "request": { + "name": "Get users", + "description": { + "content": "This endpoint can retrieve users from Lifecycle or you can search for users using parameters", + "type": "text/plain" + }, + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user login to search by", + "type": "text/plain" + }, + "key": "login", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user title to search by", + "type": "text/plain" + }, + "key": "title", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "The user email to search by", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "cd584fe0-80b7-433a-a8fa-f52b19133e34", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user login to search by", + "type": "text/plain" + }, + "key": "login", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user title to search by", + "type": "text/plain" + }, + "key": "title", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "The user email to search by", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "471e4d7e-823f-4059-aa2e-8d71f4c425ad", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user login to search by", + "type": "text/plain" + }, + "key": "login", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user title to search by", + "type": "text/plain" + }, + "key": "title", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "The user email to search by", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6edacb8b-9fc3-40d6-952c-fa5aa76d0654", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user login to search by", + "type": "text/plain" + }, + "key": "login", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The user title to search by", + "type": "text/plain" + }, + "key": "title", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "The user email to search by", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b351837b-9350-494e-81b0-2eead0e0e12b", + "name": "Create multiple new users", + "request": { + "name": "Create multiple new users", + "description": { + "content": "Create multiple new users", + "type": "text/plain" + }, + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "98d6626f-5228-453b-bc35-10f669fdf449", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "036d3655-362c-4e13-90c7-987d2e69a0fb", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cec68368-f5aa-4173-b4dd-89ab5b0f7ae0", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3dac5fb3-6ba4-4a2e-a7df-8e2a8708281c", + "name": "Update multiple users", + "request": { + "name": "Update multiple users", + "description": { + "content": "Update multiple users", + "type": "text/plain" + }, + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "54d4b3cb-1e6b-43e3-a04f-f6b0adc852fb", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "197f0a4e-e6b0-4019-9db4-af670e298bf0", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d88b8724-9027-47a9-a23d-c59e9cb503b6", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "92474c00-ee04-4f3f-a48b-e3da2c5166f3", + "name": "Find user by id", + "request": { + "name": "Find user by id", + "description": { + "content": "Info for a specific user", + "type": "text/plain" + }, + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "a9ad16f9-4f58-4686-950a-e3d187a6b282", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "237c6aab-df83-4ac0-97e1-1c651825b85a", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a8d74a0c-7925-4b5c-aa78-206d7bdd8de4", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "3c41bafe-b9d7-4e3d-8e95-897948a97c4c", + "name": "Update a user by id", + "request": { + "name": "Update a user by id", + "description": { + "content": "Update a user by id", + "type": "text/plain" + }, + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "0b954759-24f7-438f-ad4f-80e44406d9ee", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"title\": \"\",\n \"status\": \"Disabled\",\n \"login\": \"\",\n \"last_login\": \"\",\n \"cookies_accepted_at\": \"\",\n \"preferred_language\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "11e08af9-8ad2-4e05-b785-7d83a2b0156b", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ed14951b-b269-46ae-880f-85afa882a2e0", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"title\": \"\",\n \"status\": \"Active\",\n \"login\": \"\",\n \"group_strings\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "5ac1cefb-b447-4d71-99f1-11dd05f0428c", + "name": "Delete a user", + "request": { + "name": "Delete a user", + "description": { + "content": "Delete a user", + "type": "text/plain" + }, + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "79e01dd5-2eb8-4964-9d21-9e20d2f490c8", + "name": "Info about the operation", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"info\": {\n \"description\": \"A message confirming the operation\",\n \"example\": \"object deleted\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48828143-7017-42b9-8ca3-7d45f250e3c1", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "871ddc0e-a0f9-4c35-9ced-8d43bf6196fc", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "avatar", + "description": "", + "item": [ + { + "id": "3e42d02d-546a-433c-807d-504970129d33", + "name": "Retrieves the URL of the user avatar", + "request": { + "name": "Retrieves the URL of the user avatar", + "description": { + "content": "Retrieves the URL of the user avatar", + "type": "text/plain" + }, + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "046b3854-93d3-403f-ab2e-725e60ed71b6", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e0f4b529-7b2c-4379-bbed-13fe63fc4a3a", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0dbc025-99ba-4f9c-a4d9-a26ccd7e735a", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "63e23cec-c783-4fa4-be2d-84921336052d", + "name": "Uploads a new user avatar", + "request": { + "name": "Uploads a new user avatar", + "description": { + "content": "Uploads a new user avatar", + "type": "text/plain" + }, + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + }, + "auth": null + }, + "response": [ + { + "id": "b5012489-62f2-47db-b35f-ace8b0e96e9c", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4d29d136-52f9-491d-9fb1-fc140e694277", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "023304e4-1c98-4f67-9de3-2e763906957e", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "users", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "user_manager", + "description": "", + "item": [ + { + "id": "cf67a2e6-9765-413a-9784-04d8267a31a0", + "name": "Create a new user-manager relationship", + "request": { + "name": "Create a new user-manager relationship", + "description": { + "content": "Create a new user-manager relationship", + "type": "text/plain" + }, + "url": { + "path": [ + "user_manager" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "dff3476b-33e6-430a-ab75-035139dee42c", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_manager" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_manager\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7ef30a16-c615-4551-aeb2-039f8cb07972", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_manager" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "285d429c-656c-44e6-815e-afd222ea709d", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_manager" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "user_managers", + "description": "", + "item": [ + { + "id": "b31f27ae-c5cf-4115-a9d4-1adb77e0cf56", + "name": "Get user-manager relationships", + "request": { + "name": "Get user-manager relationships", + "description": { + "content": "This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters", + "type": "text/plain" + }, + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "manager_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "3121083d-4fd5-46e5-bca4-03634cb76eae", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "manager_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_managers\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "14b21b0a-66e2-41ad-962d-c0e7f13308db", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "manager_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "089fd00d-fc2d-4ccd-9670-f3a5237d4ae9", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "manager_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c8981683-c8cb-4197-8e10-bebd5f0ce39e", + "name": "Create multiple new user-manager relationships", + "request": { + "name": "Create multiple new user-manager relationships", + "description": { + "content": "Create multiple new user-manager relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "f2f46a63-4cff-4a4a-8c87-e70abe73b923", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"info\": \"\",\n \"job_status\": {\n \"job_id\": \"\",\n \"status\": \"\"\n },\n \"status\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f18922c8-4e56-46fd-ac1e-44f702630c4e", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e79e2db8-375c-462c-a36b-8e7f25fc6b50", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a3ae98b9-04f6-44f7-96c8-a86d7a415735", + "name": "Update multiple user-manager relationships", + "request": { + "name": "Update multiple user-manager relationships", + "description": { + "content": "Update multiple user-manager relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "c429f403-bccf-42f1-a92e-d55e5ea862a3", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"info\": \"\",\n \"job_status\": {\n \"job_id\": \"\",\n \"status\": \"\"\n },\n \"status\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d686b2da-3d97-468a-ab07-d802f93a4508", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3aab8ed8-d549-4b93-a21b-35cb86998131", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_managers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_managers\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "722bd4a7-1928-4253-9bfa-4711de772533", + "name": "Find user-manager relationship by id", + "request": { + "name": "Find user-manager relationship by id", + "description": { + "content": "Info for a specific user-manager relationship", + "type": "text/plain" + }, + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "648bbe18-f828-42e9-b63d-ae9e07eed86f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_manager\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ddb33d2e-6e8f-49e6-81cb-0ee1928f419f", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53ea1c44-a75a-48b2-8a1a-889de101deb8", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b9985e01-ffb3-4c14-9173-d99d16c7738e", + "name": "Update a user-manager relationship by id", + "request": { + "name": "Update a user-manager relationship by id", + "description": { + "content": "Update a user-manager relationship by id", + "type": "text/plain" + }, + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "8e475da0-b4e2-4aae-8270-a48278884693", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_manager\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "450a1b9f-981f-456e-ad5c-0e03df0ee560", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f08ad82-ab6b-447e-916d-800a3ef0bc13", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_managers", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_manager\": {\n \"user_id\": \"\",\n \"manager_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "roles", + "description": "", + "item": [ + { + "id": "9d1195a4-e45a-436c-9f2b-1ef40b00323f", + "name": "Get roles", + "request": { + "name": "Get roles", + "description": { + "content": "This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results.", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "b69f1a1e-0d1e-4e94-a360-58a357ff2aa6", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"roles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ab00ec2-c169-44be-ba52-bebfb4aef231", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "21023955-27dc-4555-a5fe-b290b14cba13", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "6a422221-1b09-400d-b7a2-e007cae4d77d", + "name": "Create multiple new roles", + "request": { + "name": "Create multiple new roles", + "description": { + "content": "Create multiple new users", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"uid\": \"\",\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "ee7deec4-211c-49ad-b9e1-41deead871e6", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"uid\": \"\",\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"roles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aefb6f56-d63c-42ac-890a-1d1d7c013fbb", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"uid\": \"\",\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9009d03e-4aa3-4a14-bc2f-7d982da59869", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"uid\": \"\",\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "eda056df-f20d-439a-8b33-adf2cdaff168", + "name": "Update multiple roles", + "request": { + "name": "Update multiple roles", + "description": { + "content": "Update multiple users", + "type": "text/plain" + }, + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "bae1d08b-7dc4-4d11-be3e-20f0a2622fac", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"roles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6f627215-d14c-4de5-a76f-f69954efcf47", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9457778d-23cf-44ae-9bf5-9030c07a282b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"roles\": [\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n },\n {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "48358be2-7c63-41b9-8735-84f4d3e97225", + "name": "Find role by id", + "request": { + "name": "Find role by id", + "description": { + "content": "Info for a specific user role", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "5c6580ab-722e-4e83-9ba4-9dd1abee819f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c6e75c1c-b403-471d-bbc0-29c4e488cdc7", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "97c53f63-35d6-4acb-a952-bf64507493ac", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "022706c9-f4d0-4760-a4fd-88a7fc8a345e", + "name": "Update an existing role", + "request": { + "name": "Update an existing role", + "description": { + "content": "Update an existing role", + "type": "text/plain" + }, + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "442ee041-26b2-4cb0-8fd0-f8cf51b76c41", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62ad0784-6ee5-41b9-86d3-b54f87f3566b", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a2b9b25a-00ed-4e1d-8098-e1a8ba831979", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"type\": \"NeprofileRole\",\n \"name\": \"\",\n \"archived\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "role", + "description": "", + "item": [ + { + "id": "c50e030c-813b-4bdf-8a91-95227e79a565", + "name": "Create a new role", + "request": { + "name": "Create a new role", + "description": { + "content": "Create a new role", + "type": "text/plain" + }, + "url": { + "path": [ + "role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "75a19967-e281-4f63-85a6-ae70b6553752", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4b6f0efc-056f-4632-bf61-050b6b9d648a", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f2cd9029-a8b6-4396-8e05-1c078b543d6b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role\": {\n \"uid\": \"\",\n \"type\": \"NeaccessRole\",\n \"name\": \"\",\n \"groups\": [\n \"\",\n \"\"\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "permissions", + "description": "", + "item": [ + { + "id": "4455068f-b755-4893-b507-b05bb35544a0", + "name": "Create a permission", + "request": { + "name": "Create a permission", + "description": { + "content": "This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration", + "type": "text/plain" + }, + "url": { + "path": [ + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"permission\": {\n \"role_id\": \"\",\n \"subject_id\": \"\",\n \"value\": 4,\n \"subject\": 16\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "ae7fffa5-00ea-4655-bbff-c5e73fb30558", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"permission\": {\n \"role_id\": \"\",\n \"subject_id\": \"\",\n \"value\": 4,\n \"subject\": 16\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"permission\": {\n \"id\": \"\",\n \"role_id\": \"\",\n \"value\": \"\",\n \"subject\": \"\",\n \"subject_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "153c4c45-1d25-40b3-ade1-197868480c1f", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"permission\": {\n \"role_id\": \"\",\n \"subject_id\": \"\",\n \"value\": 4,\n \"subject\": 16\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3368d313-a63e-4c9c-bdee-b8e34b5341a3", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"permission\": {\n \"role_id\": \"\",\n \"subject_id\": \"\",\n \"value\": 4,\n \"subject\": 16\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "user_role", + "description": "", + "item": [ + { + "id": "c802af97-35de-464d-ad6f-bef68a69b19c", + "name": "Assign a new role to a user", + "request": { + "name": "Assign a new role to a user", + "description": { + "content": "Assign a new role to a user", + "type": "text/plain" + }, + "url": { + "path": [ + "user_role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "abdd3600-b185-45b3-b523-e468b80b8f4f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_role\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f5e18f12-5246-4f31-82ee-16bdd7b0fc0b", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "41898da8-2f2e-4f08-b82f-0e886fe610a2", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_role" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "6bd9a078-5a26-4931-af22-8f567c3fe4c1", + "name": "Delete a user role assignment", + "request": { + "name": "Delete a user role assignment", + "description": { + "content": "Delete a user role assignment", + "type": "text/plain" + }, + "url": { + "path": [ + "user_role", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "8b031506-f478-4183-877a-88024db67193", + "name": "User role was destroyed", + "originalRequest": { + "url": { + "path": [ + "user_role", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f73251d1-c202-4940-b8a6-f8f851e494ef", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_role", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "26196064-03f0-40d1-81dc-87a1ab454937", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_role", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "user_roles", + "description": "", + "item": [ + { + "id": "32caf4f6-f823-4d41-9be7-015e2f2faf98", + "name": "Get user role pairings", + "request": { + "name": "Get user role pairings", + "description": { + "content": "This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters", + "type": "text/plain" + }, + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "30e11e7b-14e6-4907-965a-608fe44264a0", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9325492-8144-4d1a-86bf-7bceb154400d", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "286f3639-6d63-47e4-99a0-b905b2a46adf", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c797e606-a510-41aa-b5da-d7758cce7381", + "name": "Create multiple new user role pairings", + "request": { + "name": "Create multiple new user role pairings", + "description": { + "content": "Create multiple new user role pairings", + "type": "text/plain" + }, + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "14ae3f40-b43c-41fe-8a49-5bdbb23eaae1", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "71eff5c7-f85e-47d4-ac3b-5ef5d6fdcbdc", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a8a9b387-9ab8-48d5-aff7-e8817e63a85d", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "df84c88f-3adf-41ca-8846-5c4746b1b0d1", + "name": "Update multiple user role pairings", + "request": { + "name": "Update multiple user role pairings", + "description": { + "content": "Update multiple user role pairings", + "type": "text/plain" + }, + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "6c52fa80-d625-469d-b466-40a28d72d1ae", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aa48f042-a72a-4737-9879-87fed2ef908c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e9c18723-8dbe-4cc6-9aec-a9aa62f18053", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_roles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "d3b6232f-4f03-452b-8809-479ab0a8d902", + "name": "Find user role pairing by id", + "request": { + "name": "Find user role pairing by id", + "description": { + "content": "Info for a specific user role pairing", + "type": "text/plain" + }, + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "8d144994-e19f-4b55-a276-c16d385f5d8f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_role\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "495cd6a2-c436-4c15-9be6-a7eb04bf0667", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2fd1be66-b5f2-4ba1-abaf-4bd41b351a3c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "9cb2e7d9-0d19-459f-8fe5-ab7ce181f58a", + "name": "Update a user role pairing by id", + "request": { + "name": "Update a user role pairing by id", + "description": { + "content": "Update a user role pairing by id", + "type": "text/plain" + }, + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "bcfe6a7f-da89-475c-8572-b1326a550b42", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_role\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d3b20b1-40a6-491c-84ba-2d39cdfac7c7", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5791dcad-c4f6-4540-b21f-a20923fe2790", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_roles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_role\": {\n \"user_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "ne_attributes", + "description": "", + "item": [ + { + "id": "f6ba96c1-0a2f-4c61-b406-a7c970c885df", + "name": "Get attribute data in bulk", + "request": { + "name": "Get attribute data in bulk", + "description": { + "content": "This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute data type to filter by", + "type": "text/plain" + }, + "key": "data_type", + "value": "attachment" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "3c31e4ad-655f-42e7-a54e-27d5abe56d93", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute data type to filter by", + "type": "text/plain" + }, + "key": "data_type", + "value": "attachment" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"tool_tip\": \"\",\n \"crypt\": \"\",\n \"archived\": \"\",\n \"archived_on\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"date_format\": \"yyyy/mm/dd\",\n \"selectable_status\": \"\",\n \"risk_score_setting\": \"\",\n \"risk_type\": \"\",\n \"ownership_driver\": \"\",\n \"allow_multiple_selections\": \"\",\n \"filtered_by_ne_attribute\": \"\",\n \"filtering_ne_attribute_id\": \"\",\n \"ne_attribute_filter_id\": \"\",\n \"reverse_association_attribute_id\": \"\",\n \"profile_type_id\": \"\",\n \"legacy_id\": \"\",\n \"tmp_created_at\": \"\",\n \"tmp_updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"tool_tip\": \"\",\n \"crypt\": \"\",\n \"archived\": \"\",\n \"archived_on\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"date_format\": \"yyyy-mm-dd\",\n \"selectable_status\": \"\",\n \"risk_score_setting\": \"\",\n \"risk_type\": \"\",\n \"ownership_driver\": \"\",\n \"allow_multiple_selections\": \"\",\n \"filtered_by_ne_attribute\": \"\",\n \"filtering_ne_attribute_id\": \"\",\n \"ne_attribute_filter_id\": \"\",\n \"reverse_association_attribute_id\": \"\",\n \"profile_type_id\": \"\",\n \"legacy_id\": \"\",\n \"tmp_created_at\": \"\",\n \"tmp_updated_at\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ee804c7b-75c6-4f15-b2e1-1e2fd81c1c07", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute data type to filter by", + "type": "text/plain" + }, + "key": "data_type", + "value": "attachment" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8845aa67-9fce-45e6-9314-e2f1284f6511", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute data type to filter by", + "type": "text/plain" + }, + "key": "data_type", + "value": "attachment" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "c0ee461e-d67d-4ee1-8956-48a72619bbf3", + "name": "Find attribute data by id", + "request": { + "name": "Find attribute data by id", + "description": { + "content": "Info for a specific attribute", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attributes", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "b37e8331-997a-49e0-8576-bd0f8f3f6bf4", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attributes", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"tool_tip\": \"\",\n \"crypt\": \"\",\n \"archived\": \"\",\n \"archived_on\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"date_format\": \"yyyy-mm-dd\",\n \"selectable_status\": \"\",\n \"risk_score_setting\": \"\",\n \"risk_type\": \"\",\n \"ownership_driver\": \"\",\n \"allow_multiple_selections\": \"\",\n \"filtered_by_ne_attribute\": \"\",\n \"filtering_ne_attribute_id\": \"\",\n \"ne_attribute_filter_id\": \"\",\n \"reverse_association_attribute_id\": \"\",\n \"profile_type_id\": \"\",\n \"legacy_id\": \"\",\n \"tmp_created_at\": \"\",\n \"tmp_updated_at\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cf6d3dc5-f99b-41f4-bfc8-f98eb9675d4d", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attributes", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35316385-2799-4eba-b3ef-0fb93e31a802", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attributes", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "ne_attribute_option", + "description": "", + "item": [ + { + "id": "65921ae2-1679-4f28-ade2-1b137eefb316", + "name": "Add a value to an option based attribute", + "request": { + "name": "Add a value to an option based attribute", + "description": { + "content": "Add a value to an option based attribute", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_option" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "359af958-d5bb-4c6f-a194-fec1e10dd46a", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_option" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute_option\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6fc76fc4-17ba-479d-abb9-7cb3af24a498", + "name": "Invalid input", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_option" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Method Not Allowed", + "code": 405, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "ne_attribute_options", + "description": "", + "item": [ + { + "id": "947a6a3a-fc28-436b-9ef7-d5ca993ea369", + "name": "Get option based attribute values", + "request": { + "name": "Get option based attribute values", + "description": { + "content": "Get option based attribute values", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "f6b863d3-3fbd-4f09-a461-b572b405c121", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c6e14b1-f6fc-43e5-b4ea-2037a3191257", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2b18e2a1-a3be-47ae-93e1-5be44bf18807", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "277a6c47-66cf-4d87-9639-2f095e7ef96e", + "name": "Create multiple new option based attribute values", + "request": { + "name": "Create multiple new option based attribute values", + "description": { + "content": "Create multiple new option based attribute values", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "a8d44041-375f-4238-9c27-8072c7ed4784", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aefee64c-51a1-4b4c-b5c7-9f8655df8102", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7613e632-b8ac-4a0c-a6cd-e090ea4ffa2b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "02bd201a-6bd2-4d0c-b80d-3dde7df4d515", + "name": "Update multiple option based attribute values", + "request": { + "name": "Update multiple option based attribute values", + "description": { + "content": "Update multiple option based attribute values", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "649d2436-b626-41e9-83a2-25324fe46718", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d80358a-9a11-4a12-974a-a731a3bc71b1", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ce4f9af-1a56-4929-a0b3-b311b6012934", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_options\": [\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n },\n {\n \"id\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "eb033c6c-9ed8-47e5-851f-026052dcfb15", + "name": "Find option based attribute value by id", + "request": { + "name": "Find option based attribute value by id", + "description": { + "content": "Info for a specific option based attribute value", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "316c7047-059a-4fa2-bb7e-4d1234cfe423", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute_option\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "49afd195-ea0d-4181-91eb-0bccda2b014c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1e08fbe0-2682-4cd5-a981-5e05fb5bc6ae", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "fb755421-902f-461b-905c-0ea8741fbde8", + "name": "Update a option based attribute value by id", + "request": { + "name": "Update a option based attribute value by id", + "description": { + "content": "Update a option based attribute value by id", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "6248ce67-8747-410e-9c4c-2f13398958b7", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ne_attribute_option\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6d0f225e-5351-4383-af92-e8d82ddfb8a1", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f7f33461-6e50-4a2c-b121-1f6358252f5e", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"ne_attribute_option\": {\n \"ne_attribute_id\": \"\",\n \"option\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "63cf371c-c90b-432b-9c5d-1a0e3c72bf3c", + "name": "Delete a option based attribute value by id", + "request": { + "name": "Delete a option based attribute value by id", + "description": { + "content": "Delete a option based attribute value by id", + "type": "text/plain" + }, + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "102fc287-146e-40ea-ae88-602a9c56daec", + "name": "Confirmation of a deleted object", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"info\": \"The option '{Option Value}' has been deleted\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4984ec62-45d1-4ec7-a303-5d629cac46d8", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a661a431-2bdb-497e-b163-ecba8242e780", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "ne_attribute_options", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "pages", + "description": "", + "item": [ + { + "name": "profile_pages", + "description": "", + "item": [ + { + "id": "23aaefb5-d053-4259-97e9-8834cb685910", + "name": "Create a profile page", + "request": { + "name": "Create a profile page", + "description": { + "content": "Create a profile page", + "type": "text/plain" + }, + "url": { + "path": [ + "pages", + "profile_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "d02152db-995d-4d96-ac76-64f33381cb41", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "pages", + "profile_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2f399617-52f3-49c8-b20a-e228593f0bba", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "pages", + "profile_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4f8f5435-09bf-4e9c-8996-8f84f1666a44", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "pages", + "profile_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "workflow_pages", + "description": "", + "item": [ + { + "id": "5e141402-a673-46b1-b74f-46877665cb02", + "name": "Create a workflow page", + "request": { + "name": "Create a workflow page", + "description": { + "content": "Create a workflow page", + "type": "text/plain" + }, + "url": { + "path": [ + "pages", + "workflow_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "2090c570-8bb3-44fd-8260-d801a8f7b9ed", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "pages", + "workflow_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "da9bd76a-b9f5-464d-a27c-b10ca9792541", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "pages", + "workflow_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abe19f8f-a6e8-478e-955a-1ea4e6e39150", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "pages", + "workflow_pages" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"page\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "profile_type", + "description": "", + "item": [ + { + "id": "e72cba3c-714b-48e3-8bd8-fc67f1b6562f", + "name": "Create a profile type", + "request": { + "name": "Create a profile type", + "description": { + "content": "Create a profile type", + "type": "text/plain" + }, + "url": { + "path": [ + "profile_type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": false,\n \"archived\": false,\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "f654427e-8f51-4046-8266-766f07f0859d", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profile_type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": false,\n \"archived\": false,\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile_type\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3c6a24e4-cb38-4c2f-8b0f-83208d4352f0", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile_type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": false,\n \"archived\": false,\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c3a613d-6f3f-4a35-88e6-768595e13ae7", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile_type" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": false,\n \"archived\": false,\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "profile_types", + "description": "", + "item": [ + { + "id": "3a8ea50d-3817-42ea-9cc6-376df12693e7", + "name": "Get profile types", + "request": { + "name": "Get profile types", + "description": { + "content": "Get option based attribute values", + "type": "text/plain" + }, + "url": { + "path": [ + "profile_types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter by archive status", + "type": "text/plain" + }, + "key": "archived", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "e3d3d73d-ff25-496e-b9c4-071e581c0357", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profile_types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter by archive status", + "type": "text/plain" + }, + "key": "archived", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile_types\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8bd24cd8-6427-48e5-887e-0baf5b98787b", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile_types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter by archive status", + "type": "text/plain" + }, + "key": "archived", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a1e4712-a1d3-46c8-bc79-9dc6abb256ce", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile_types" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Filter by archive status", + "type": "text/plain" + }, + "key": "archived", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "f8ef99d0-97f5-4e6b-bd68-ff48bba28630", + "name": "Find profile type by id", + "request": { + "name": "Find profile type by id", + "description": { + "content": "Find profile type by id", + "type": "text/plain" + }, + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "5e964430-1647-462a-b4bb-0186d3915805", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile_type\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "556424a0-a678-41d9-9b92-63e2360ef4be", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "560e9310-7551-42ed-84da-783d434f1618", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a159ecb8-f91a-4b2f-9b67-611282ac7634", + "name": "Update a profile type by id", + "request": { + "name": "Update a profile type by id", + "description": { + "content": "Update a profile type by id", + "type": "text/plain" + }, + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "fbc74309-ee3f-4365-9713-1a1b193dbca1", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile_type\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8cda9007-293a-4f5c-bdc5-61be0d130be9", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10256cd9-db4b-4427-95a1-65b8ce9b1632", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile_type\": {\n \"name\": \"\",\n \"bypass_dup_protection\": \"\",\n \"archived\": \"\",\n \"permitted_role_ids\": [\n \"\",\n \"\"\n ],\n \"profile_type_dup_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\"\n }\n ],\n \"profile_type_namings\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"profile_type_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"order\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "05a0e80c-4390-430d-90e1-be2c43be731a", + "name": "Delete profile type", + "request": { + "name": "Delete profile type", + "description": { + "content": "Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed.", + "type": "text/plain" + }, + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "697012ef-6587-47df-9fb1-0c4583ec8116", + "name": "Info about the operation", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"info\": {\n \"description\": \"A message confirming the operation\",\n \"example\": \"object deleted\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "212a0a29-59e8-459c-ba0d-53de6d4d1f4d", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1013a5c2-2590-44d1-a47c-e0792b30a61e", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile_types", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "profile_type_roles", + "description": "", + "item": [ + { + "id": "5b566dde-28e6-479a-a4a6-f8c185ab1d2b", + "name": "Create a profile type role", + "request": { + "name": "Create a profile type role", + "description": { + "content": "This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type", + "type": "text/plain" + }, + "url": { + "path": [ + "profile_type_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"profile_type_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "efba3744-f011-4780-ad85-7755ff4226a1", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profile_type_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"profile_type_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"form\": {\n \"profile_type_id\": \"\",\n \"role_id\": \"\",\n \"id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bff511f9-b397-4243-9e22-4a01796320e8", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile_type_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"profile_type_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae19a9b8-a13f-4ab0-b1f2-9f86151477d8", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile_type_roles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"profile_type_id\": \"\",\n \"role_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "profile", + "description": "", + "item": [ + { + "id": "6514b2cf-21ff-48cd-957c-e7d2fedfd008", + "name": "Create a profile", + "request": { + "name": "Create a profile", + "description": { + "content": "Create a profile", + "type": "text/plain" + }, + "url": { + "path": [ + "profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"nulla_bde\": \"\",\n \"ex_30\": \"\",\n \"Loremf\": \"\",\n \"in6e6\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "a918d136-cea6-46d2-a322-37193a32be82", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"nulla_bde\": \"\",\n \"ex_30\": \"\",\n \"Loremf\": \"\",\n \"in6e6\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"nisi21\": \"\",\n \"nond\": \"\",\n \"Ut03a\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5ed0dcea-1472-415c-a000-0c04b7bba2e9", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"nulla_bde\": \"\",\n \"ex_30\": \"\",\n \"Loremf\": \"\",\n \"in6e6\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2286341c-4284-4cd9-9b14-a201b09cad28", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"nulla_bde\": \"\",\n \"ex_30\": \"\",\n \"Loremf\": \"\",\n \"in6e6\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "profiles", + "description": "", + "item": [ + { + "id": "129d5b06-d0b4-4610-bb37-d688b6469126", + "name": "Get profiles", + "request": { + "name": "Get profiles", + "description": { + "content": "Get profiles", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for optimization by not returning the associated attribute data for the returned profiles", + "type": "text/plain" + }, + "key": "exclude_attributes", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile Type ID for filtering", + "type": "text/plain" + }, + "key": "profile_type_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "d791d8ef-de84-4e8a-a862-af156b21f356", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for optimization by not returning the associated attribute data for the returned profiles", + "type": "text/plain" + }, + "key": "exclude_attributes", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile Type ID for filtering", + "type": "text/plain" + }, + "key": "profile_type_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"ut4\": \"\",\n \"eaf0\": \"\",\n \"aliqua2fe\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"On Leave\",\n \"id_proofing_status\": \"fail\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"eu_7\": \"\",\n \"minim_24\": \"\"\n }\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e60dc4f4-4a2b-4bf7-b0c6-a3444d694350", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for optimization by not returning the associated attribute data for the returned profiles", + "type": "text/plain" + }, + "key": "exclude_attributes", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile Type ID for filtering", + "type": "text/plain" + }, + "key": "profile_type_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "61d1533f-b647-44dd-8836-37d33560912c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for optimization by not returning the associated attribute data for the returned profiles", + "type": "text/plain" + }, + "key": "exclude_attributes", + "value": "false" + }, + { + "disabled": false, + "description": { + "content": "object name for filtering", + "type": "text/plain" + }, + "key": "name", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile Type ID for filtering", + "type": "text/plain" + }, + "key": "profile_type_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "status value for filtering", + "type": "text/plain" + }, + "key": "status", + "value": "Inactive" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "da2f3ac8-d485-4b02-830c-91f779e4c9e8", + "name": "Create multiple profiles", + "request": { + "name": "Create multiple profiles", + "description": { + "content": "Create multiple profiles", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"amet_8d\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"Duis_0\": \"\",\n \"in_8b\": \"\",\n \"utf0d\": \"\",\n \"aliqua_b\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "d410b125-b655-4fb5-bc7e-7e5a116d9c96", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"amet_8d\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"Duis_0\": \"\",\n \"in_8b\": \"\",\n \"utf0d\": \"\",\n \"aliqua_b\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"dolore_0\": \"\",\n \"consequat17c\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"ipsumb8\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c8277d2e-3d46-4c36-8429-638917d4c569", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"amet_8d\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"Duis_0\": \"\",\n \"in_8b\": \"\",\n \"utf0d\": \"\",\n \"aliqua_b\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a55fa58-8ac0-42e8-922d-884344507971", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"amet_8d\": \"\"\n }\n },\n {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Inactive\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"Duis_0\": \"\",\n \"in_8b\": \"\",\n \"utf0d\": \"\",\n \"aliqua_b\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d0028043-cef7-4cd1-9381-386c927b6a8e", + "name": "Update multiple profiles", + "request": { + "name": "Update multiple profiles", + "description": { + "content": "Update multiple profiles", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"enimf6a\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"On Leave\",\n \"id_proofing_status\": \"pending\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur_15_\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "b661fbc4-1701-4756-881a-958dda841d60", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"enimf6a\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"On Leave\",\n \"id_proofing_status\": \"pending\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur_15_\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"dolore_0\": \"\",\n \"consequat17c\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"ipsumb8\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0e492050-a551-49e5-aa1d-e0f1ed1ab374", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"enimf6a\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"On Leave\",\n \"id_proofing_status\": \"pending\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur_15_\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98785c11-abe9-47a9-ba00-6b1412f666a7", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pass\",\n \"archived\": false,\n \"attributes\": {\n \"enimf6a\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"On Leave\",\n \"id_proofing_status\": \"pending\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur_15_\": \"\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "63ea7e80-b379-4bb8-b480-8a38f68afcdd", + "name": "Delete multiple profiles", + "request": { + "name": "Delete multiple profiles", + "description": { + "content": "Delete multiple profiles", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "2caa38b4-7840-4739-9890-17b8ae65ad43", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"dolore_0\": \"\",\n \"consequat17c\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"ipsumb8\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "aedda53c-a895-4cc3-815b-bb8a696cfd45", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1d0784f2-197e-4c6f-960f-e054d516c683", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "38e0a136-098b-4211-abea-7b3f19796496", + "name": "Find profile by id", + "request": { + "name": "Find profile by id", + "description": { + "content": "Find profile by id", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "5032d9b6-4c1a-4c18-86e6-2432c3f62263", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"nisi21\": \"\",\n \"nond\": \"\",\n \"Ut03a\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d619a4cf-ca8d-4629-8e55-a3c49b6ef4e1", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13cb4de9-9d90-46a1-9e45-f516a01d113e", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c52cfc82-3143-4bfc-9cb5-7b183f8493dc", + "name": "Update a profile by id", + "request": { + "name": "Update a profile by id", + "description": { + "content": "Update a profile by id", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur0a\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "04de3e89-437c-43fc-bf01-b33d33eb5f44", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur0a\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"nisi21\": \"\",\n \"nond\": \"\",\n \"Ut03a\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1197d315-2ca5-4cb6-bab2-7138ab48f9b5", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur0a\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b4a33c92-6880-466e-a96c-615c228532a9", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"profile\": {\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Active\",\n \"id_proofing_status\": \"fail\",\n \"archived\": false,\n \"attributes\": {\n \"pariatur0a\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "fadde427-83dd-4f6d-bdfb-63ec872eab4c", + "name": "Delete a single profile", + "request": { + "name": "Delete a single profile", + "description": { + "content": "Delete a single profile", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "9c10e9dc-e5ff-4172-9e03-10747678edb5", + "name": "The Profile was successfully deleted.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + }, + { + "id": "f0632252-84c9-4bfe-80df-b2b467e38bb9", + "name": "Error deleting Profile", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3364c238-56e8-4b29-927c-3e986a105658", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "upload", + "description": "", + "item": [ + { + "name": "{attribute_id}", + "description": "", + "item": [ + { + "id": "7a765eb1-7ce7-4d08-855b-d5d6460f5fb5", + "name": "Retrieves the URL of an attachment attribute value from a profile", + "request": { + "name": "Retrieves the URL of an attachment attribute value from a profile", + "description": { + "content": "Retrieves the URL of an attachment attribute value from a profile", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attribute_id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "684a1c14-c7df-4763-8e7c-62228a179273", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "507d7923-1644-4e68-be3d-b72e3e146150", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "284d15a6-6505-4839-b851-173df99a0b2c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "8861c926-7b0f-44d8-87fe-b6c685ae498e", + "name": "Uploads a new attachment attribute value to a profile", + "request": { + "name": "Uploads a new attachment attribute value to a profile", + "description": { + "content": "Uploads a new attachment attribute value to a profile", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attribute_id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + }, + "auth": null + }, + "response": [ + { + "id": "f613f35a-8243-4bb5-ab08-2ec2fb1c8328", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d1b90047-426b-4ea0-92e9-d8f693a0921c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6470d390-ec41-4089-b9c3-5fa5c0ea4d5d", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "avatar", + "description": "", + "item": [ + { + "id": "6cbb3f1c-3717-4bd2-969c-c6d6b545f4da", + "name": "Retrieves the URL of the profile avatar", + "request": { + "name": "Retrieves the URL of the profile avatar", + "description": { + "content": "Retrieves the URL of the profile avatar", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "75614de2-ce48-4148-965c-3c93b0ac014f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9ffa0bb4-b034-4262-b986-d972437ae2b7", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0138827c-ea56-483c-a00f-a3742586b7f0", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e03eefd5-3d00-45d1-a737-6b0b39bc6acd", + "name": "Uploads a new profile avatar", + "request": { + "name": "Uploads a new profile avatar", + "description": { + "content": "Uploads a new profile avatar", + "type": "text/plain" + }, + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + }, + "auth": null + }, + "response": [ + { + "id": "977bf93e-edb1-4c8d-ac9f-3fe48c9bbdf4", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1897ef92-021d-4d8c-a278-8e61d57aaeb8", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae51be90-6f1b-4f77-b6b4-cbd450c1cb24", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "profiles", + ":id", + "avatar" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "risk_scores", + "description": "", + "item": [ + { + "id": "db2125e5-5557-499b-94fa-8a4bd30b52b0", + "name": "Get risk score data in bulk", + "request": { + "name": "Get risk score data in bulk", + "description": { + "content": "This endpoint can retrieve risk score data in bulk from Lifecycle", + "type": "text/plain" + }, + "url": { + "path": [ + "risk_scores" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an object for filtering. Used along with object_type", + "type": "text/plain" + }, + "key": "object_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of object that object_id represents", + "type": "text/plain" + }, + "key": "object_type", + "value": "WorkflowSession" + }, + { + "disabled": false, + "description": { + "content": "Overall risk level to filter by", + "type": "text/plain" + }, + "key": "overall_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Impact risk level to filter by", + "type": "text/plain" + }, + "key": "impact_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Probability risk level to filter by", + "type": "text/plain" + }, + "key": "probability_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "1a70fc27-a44c-4064-b057-75361c42a513", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "risk_scores" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an object for filtering. Used along with object_type", + "type": "text/plain" + }, + "key": "object_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of object that object_id represents", + "type": "text/plain" + }, + "key": "object_type", + "value": "WorkflowSession" + }, + { + "disabled": false, + "description": { + "content": "Overall risk level to filter by", + "type": "text/plain" + }, + "key": "overall_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Impact risk level to filter by", + "type": "text/plain" + }, + "key": "impact_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Probability risk level to filter by", + "type": "text/plain" + }, + "key": "probability_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"risk_scores\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"object_id\": \"\",\n \"object_type\": \"Profile\",\n \"overall_score\": \"\",\n \"overall_risk_level_id\": \"\",\n \"impact_score\": \"\",\n \"impact_risk_level_id\": \"\",\n \"probability_score\": \"\",\n \"probability_risk_level_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"object_id\": \"\",\n \"object_type\": \"Profile\",\n \"overall_score\": \"\",\n \"overall_risk_level_id\": \"\",\n \"impact_score\": \"\",\n \"impact_risk_level_id\": \"\",\n \"probability_score\": \"\",\n \"probability_risk_level_id\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ceb9179a-38b1-435a-be47-e3491b6f7b7e", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "risk_scores" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an object for filtering. Used along with object_type", + "type": "text/plain" + }, + "key": "object_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of object that object_id represents", + "type": "text/plain" + }, + "key": "object_type", + "value": "WorkflowSession" + }, + { + "disabled": false, + "description": { + "content": "Overall risk level to filter by", + "type": "text/plain" + }, + "key": "overall_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Impact risk level to filter by", + "type": "text/plain" + }, + "key": "impact_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Probability risk level to filter by", + "type": "text/plain" + }, + "key": "probability_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "887fa6d4-fa51-4ff5-9b31-2798340b4df6", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "risk_scores" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an object for filtering. Used along with object_type", + "type": "text/plain" + }, + "key": "object_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of object that object_id represents", + "type": "text/plain" + }, + "key": "object_type", + "value": "WorkflowSession" + }, + { + "disabled": false, + "description": { + "content": "Overall risk level to filter by", + "type": "text/plain" + }, + "key": "overall_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Impact risk level to filter by", + "type": "text/plain" + }, + "key": "impact_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Probability risk level to filter by", + "type": "text/plain" + }, + "key": "probability_risk_level_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "4fe4b47a-bc4d-4b55-9266-9bed2936c773", + "name": "Find risk score data by id", + "request": { + "name": "Find risk score data by id", + "description": { + "content": "Find risk score data by id", + "type": "text/plain" + }, + "url": { + "path": [ + "risk_scores", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "698110b3-cc55-41b1-a38f-f250f7dfe90f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "risk_scores", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"risk_score\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"object_id\": \"\",\n \"object_type\": \"WorkflowSession\",\n \"overall_score\": \"\",\n \"overall_risk_level_id\": \"\",\n \"impact_score\": \"\",\n \"impact_risk_level_id\": \"\",\n \"probability_score\": \"\",\n \"probability_risk_level_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f9c62ae6-cd16-49c2-81e4-db4ab3b481db", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "risk_scores", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18f19691-394d-424a-a993-f4a65deb4585", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "risk_scores", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "risk_levels", + "description": "", + "item": [ + { + "id": "d8680160-dc13-4b67-9f5b-a0c6167f5a89", + "name": "Get risk level data in bulk", + "request": { + "name": "Get risk level data in bulk", + "description": { + "content": "This endpoint can retrieve risk level data in bulk from Lifecycle", + "type": "text/plain" + }, + "url": { + "path": [ + "risk_levels" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "a5de8a71-0ac9-4987-a59d-5e586595f53b", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "risk_levels" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"risk_levels\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"points\": \"\",\n \"order\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"points\": \"\",\n \"order\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "433cbb8a-e098-46ab-9a2f-02a1af51e0a9", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "risk_levels" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "db60e42d-bfd1-4fd5-9c79-6059dc14d48a", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "risk_levels" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The attribute label to filter by", + "type": "text/plain" + }, + "key": "label", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e48c77b3-09a9-4458-ace5-73b0e92d22ff", + "name": "Find risk level data by id", + "request": { + "name": "Find risk level data by id", + "description": { + "content": "Find risk level data by id", + "type": "text/plain" + }, + "url": { + "path": [ + "risk_levels", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "bbee7d04-ba16-4be5-aef4-18468d195183", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "risk_levels", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"risk_level\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"points\": \"\",\n \"order\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c12d76cf-ed9d-4078-8ade-95c2ff614c02", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "risk_levels", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "13750541-f3e7-4199-aaa1-628c3175e243", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "risk_levels", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "user_profile", + "description": "", + "item": [ + { + "id": "6af352f2-dddf-4e03-b468-cba9de57672b", + "name": "Create a user-profile contributor relationship", + "request": { + "name": "Create a user-profile contributor relationship", + "description": { + "content": "Create a user-profile contributor relationship", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "873c8136-2682-48d9-938e-fe1aebd448aa", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c3bef72c-3e01-4fbc-8827-a01ce5baddd0", + "name": "Invalid input", + "originalRequest": { + "url": { + "path": [ + "user_profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Method Not Allowed", + "code": 405, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "c1b271be-5a92-4316-b18d-11628bf68157", + "name": "Delete a user profile assignment", + "request": { + "name": "Delete a user profile assignment", + "description": { + "content": "Delete a user profile assignment", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "9d5c5e14-0fd0-411d-b32e-401ba9fca9e6", + "name": "User profile was destroyed", + "originalRequest": { + "url": { + "path": [ + "user_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "445f98dc-833d-4e71-8d85-0090ce69b5ce", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6abc52b-130d-4cfe-87b3-1c255dc6d712", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "user_profiles", + "description": "", + "item": [ + { + "id": "48e9275d-05ff-4bd5-a7ab-fbecc474d959", + "name": "Get user-profile contributor relationships", + "request": { + "name": "Get user-profile contributor relationships", + "description": { + "content": "Get user-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of user contributor relationship to filter by", + "type": "text/plain" + }, + "key": "relationship_type", + "value": "owner" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "33992449-2295-4d11-a857-f0e10b32b8dc", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of user contributor relationship to filter by", + "type": "text/plain" + }, + "key": "relationship_type", + "value": "owner" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d6127f4d-e9cd-4c87-91c2-d8126d1e0346", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of user contributor relationship to filter by", + "type": "text/plain" + }, + "key": "relationship_type", + "value": "owner" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "01da63b9-b5a9-4ddb-bcd1-0229da7a086c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a user for filtering", + "type": "text/plain" + }, + "key": "user_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID of an attribute for filtering", + "type": "text/plain" + }, + "key": "ne_attribute_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Type of user contributor relationship to filter by", + "type": "text/plain" + }, + "key": "relationship_type", + "value": "owner" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "381921ca-4799-433d-9a9f-88f936e7df60", + "name": "Create multiple user-profile contributor relationships", + "request": { + "name": "Create multiple user-profile contributor relationships", + "description": { + "content": "Create multiple user-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "a3eefc84-098a-45d7-bbdf-9d54ea587ef6", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0b285d21-c114-4702-8378-051cc29d5800", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "59e5870a-1110-4f2f-89bc-fbf1c34e2384", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "7413cf22-df56-4b83-9f92-98cb799a8a6f", + "name": "Update multiple user-profile contributor relationships", + "request": { + "name": "Update multiple user-profile contributor relationships", + "description": { + "content": "Update multiple user-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "9edf9ac9-2c2a-4d1c-860f-78c7727d4c35", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bcb18959-ee21-4224-a287-9e015a95001c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b2d262e-d8a6-4efc-b63a-db8c43151af3", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "c4b34ace-bc0e-45d8-9d5f-7423613f83de", + "name": "Delete multiple user-profile contributor relationships", + "request": { + "name": "Delete multiple user-profile contributor relationships", + "description": { + "content": "Delete multiple user-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "8e3bee3d-4e29-4289-af96-b05827408c5a", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"contributor\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24711699-12c4-4693-ac03-81b799434647", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a7193b63-7314-4a73-be74-3e890605f16c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"user_profiles\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "c5851bff-ed06-48f3-9ceb-a75665bc154d", + "name": "Find user-profile contributor relationship by id", + "request": { + "name": "Find user-profile contributor relationship by id", + "description": { + "content": "Find user-profile contributor relationship by id", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "46647c00-446f-494d-9a7d-acef5b89a734", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "98d8b170-a114-4922-b5ed-7e154cc4e503", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "594bed42-f234-4f95-869b-04ecc500d704", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "683e06c3-e8a1-48b5-9b18-76343fa0c06c", + "name": "Update a user-profile contributor relationship by id", + "request": { + "name": "Update a user-profile contributor relationship by id", + "description": { + "content": "Update a user-profile contributor relationship by id", + "type": "text/plain" + }, + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "da4c0510-b69d-4b46-899e-bcfc40de9b1c", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c4b168e9-f0f6-44e6-a762-709a4bd2a5d0", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "847a092f-df90-4554-bbf5-401d43bf350e", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "user_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"user_profile\": {\n \"user_id\": \"\",\n \"profile_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"relationship_type\": \"owner\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "role_profile", + "description": "", + "item": [ + { + "id": "367fbb08-dac2-4d17-94d2-65534aadc0ac", + "name": "Create a role-profile contributor relationship", + "request": { + "name": "Create a role-profile contributor relationship", + "description": { + "content": "Create a role-profile contributor relationship", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "b1664ecc-e13d-4333-b43e-5004816cbce1", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role_profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role_profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "21c383ca-ca36-49d2-8436-e7f616a5fe01", + "name": "Invalid input", + "originalRequest": { + "url": { + "path": [ + "role_profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Method Not Allowed", + "code": 405, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "2280799e-f2ef-48bb-8fb8-12c08dfc6c70", + "name": "Delete a role profile assignment", + "request": { + "name": "Delete a role profile assignment", + "description": { + "content": "Delete a role profile assignment", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "2136cca4-372f-407d-ae48-afb34d449f6f", + "name": "Role profile was destroyed", + "originalRequest": { + "url": { + "path": [ + "role_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d02b9a80-c884-4de1-8fbb-02b512968ce6", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bac0da4f-4fbf-4fe8-8348-05aa56c435bf", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role_profile", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "DELETE", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "role_profiles", + "description": "", + "item": [ + { + "id": "39adde70-6585-4b00-ba29-cc566e112c39", + "name": "Get role-profile contributor relationships", + "request": { + "name": "Get role-profile contributor relationships", + "description": { + "content": "Get role-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "546223b8-f3fd-4bb1-8986-45ad9e82c49e", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6dc632c2-9136-402e-8a82-3c3493dda869", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "62c20bae-791a-4968-a7f9-ace64e53f56b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "The ID of a role for filtering", + "type": "text/plain" + }, + "key": "role_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "a288c903-4ea5-461c-a0ca-101d80547dbf", + "name": "Create multiple role-profile contributor relationships", + "request": { + "name": "Create multiple role-profile contributor relationships", + "description": { + "content": "Create multiple role-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "4de8525c-39c7-43ae-a6b6-21ad60414583", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "df87304c-b86b-463d-8a58-e3657611159d", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abcd73d5-2445-47e8-9a53-8655022c7789", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "64049a4b-5d1d-492d-a32f-6cba19c76487", + "name": "Update multiple role-profile contributor relationships", + "request": { + "name": "Update multiple role-profile contributor relationships", + "description": { + "content": "Update multiple role-profile contributor relationships", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "88ea1302-de34-4c9a-a3e9-2339db02477c", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9abfb3f7-de99-4527-858a-bf433b524210", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "19801ad8-239a-4f6d-ae9e-93fbb89aea11", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profiles\": [\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n },\n {\n \"id\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "802bb059-c92c-4013-af11-0dc252002430", + "name": "Find role-profile contributor relationship by id", + "request": { + "name": "Find role-profile contributor relationship by id", + "description": { + "content": "Find role-profile contributor relationship by id", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "370a9712-7751-44cb-ba13-2cb1de1a96b4", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role_profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "03a3a700-0ec8-4db2-8134-d8f5b52ad46b", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6c300e08-bdf5-4420-a7e9-904f22c50eec", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f0ca1e7d-3a07-415e-881e-cf48dc6ff6e9", + "name": "Update a role-profile contributor relationship by id", + "request": { + "name": "Update a role-profile contributor relationship by id", + "description": { + "content": "Update a role-profile contributor relationship by id", + "type": "text/plain" + }, + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "2c323d0f-6b53-45d9-b7c0-acd07b9f7552", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"role_profile\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a050b96d-1945-4677-81de-d34548374143", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cb8680fe-bc1d-43d0-90ae-fb427decaecc", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "role_profiles", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"role_profile\": {\n \"role_id\": \"\",\n \"profile_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "workflows", + "description": "", + "item": [ + { + "name": "create_workflows", + "description": "", + "item": [ + { + "id": "c921f5e1-8a7c-4f78-8207-d9289ff33376", + "name": "Create a create workflow", + "request": { + "name": "Create a create workflow", + "description": { + "content": "Create a create workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "create_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "195cd119-a70e-411f-a43a-a5bc74db1453", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "create_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ad0793c-01e5-4a76-b2f4-a9c43d0bd27d", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "create_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e882d7a-c508-4846-a885-9744c7fdf487", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "create_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "update_workflows", + "description": "", + "item": [ + { + "id": "c7940329-c9b5-4d9d-9deb-672a594d1704", + "name": "Create an update workflow", + "request": { + "name": "Create an update workflow", + "description": { + "content": "Create an update workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "update_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_status\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "a65a8509-d013-4a1d-a587-6c73047d8c99", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "update_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_status\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "543b50d4-c0cd-4de2-a065-37407696e5c4", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "update_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_status\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fc28a29f-7465-49a9-872d-c2ca21a82cfd", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "update_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_status\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "batch_workflows", + "description": "", + "item": [ + { + "id": "095dc934-418d-45ce-9a6d-3931fc7583c8", + "name": "Create a batch workflow", + "request": { + "name": "Create a batch workflow", + "description": { + "content": "Create a batch workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "batch_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"all_profiles\": \"false\",\n \"multiple_requests\": \"true\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "89e6656c-0c93-46b2-b7bf-d9f8fd800133", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "batch_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"all_profiles\": \"false\",\n \"multiple_requests\": \"true\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b493e4cc-acc5-4045-a8fe-bc836017bfbd", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "batch_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"all_profiles\": \"false\",\n \"multiple_requests\": \"true\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7db6f8ba-fd68-4035-a1d7-a6622dd2948f", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "batch_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"all_profiles\": \"false\",\n \"multiple_requests\": \"true\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "automated_workflows", + "description": "", + "item": [ + { + "id": "edc313e2-c06e-4403-8637-8208927fc24a", + "name": "Create an automated workflow", + "request": { + "name": "Create an automated workflow", + "description": { + "content": "Create an automated workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "automated_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"condition_rules_attributes\": [\n {\n \"logical_operator\": \"AND\",\n \"comparison_operator\": \">\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileExistsRule\"\n },\n {\n \"logical_operator\": \"OR\",\n \"comparison_operator\": \"<\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileStatusRule\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "51b66a21-243d-41bf-af19-fedc909d534e", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "automated_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"condition_rules_attributes\": [\n {\n \"logical_operator\": \"AND\",\n \"comparison_operator\": \">\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileExistsRule\"\n },\n {\n \"logical_operator\": \"OR\",\n \"comparison_operator\": \"<\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileStatusRule\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6169b9bb-df6d-4465-8a65-2dc218bc83b1", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "automated_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"condition_rules_attributes\": [\n {\n \"logical_operator\": \"AND\",\n \"comparison_operator\": \">\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileExistsRule\"\n },\n {\n \"logical_operator\": \"OR\",\n \"comparison_operator\": \"<\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileStatusRule\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfd1c13e-df82-45d0-bd02-be52a0e09ad0", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "automated_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"condition_rules_attributes\": [\n {\n \"logical_operator\": \"AND\",\n \"comparison_operator\": \">\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileExistsRule\"\n },\n {\n \"logical_operator\": \"OR\",\n \"comparison_operator\": \"<\",\n \"condition_object_id\": \"\",\n \"condition_object_type\": \"\",\n \"secondary_value\": \"\",\n \"tertiary_value\": \"\",\n \"value\": \"\",\n \"order\": \"\",\n \"type\": \"ProfileStatusRule\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "registration_workflows", + "description": "", + "item": [ + { + "id": "6fc13d18-afe0-4cb6-82d7-9584660fcb63", + "name": "Create a registration workflow", + "request": { + "name": "Create a registration workflow", + "description": { + "content": "Create a registration workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "registration_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "f728abf2-9a4b-4c83-b818-bf684627e04c", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "registration_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5467ee98-bbc8-44d3-b836-f6bb8cea0f9f", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "registration_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "114fc797-7d0b-40cc-bbc6-e99d8fd8ec7a", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "registration_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Disabled\",\n \"uid\": \"\",\n \"name\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "login_workflows", + "description": "", + "item": [ + { + "id": "ca3a6ad6-2893-4bb3-bbc5-8efc4a85dc32", + "name": "Create a login workflow", + "request": { + "name": "Create a login workflow", + "description": { + "content": "Create a login workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "login_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "db01889a-e39c-497c-9717-8ed8075ef813", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "login_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a5b5a251-6217-4c83-b498-d3035fa3c0c9", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "login_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0938f458-c0d3-416a-ac39-f4b4decc8647", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "login_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "password_reset_workflows", + "description": "", + "item": [ + { + "id": "27ff506a-027d-4e3f-80f6-2b0d192ed766", + "name": "Create a password reset workflow", + "request": { + "name": "Create a password reset workflow", + "description": { + "content": "Create a password reset workflow", + "type": "text/plain" + }, + "url": { + "path": [ + "workflows", + "password_reset_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "b2e28872-9da1-4ce5-a0c1-1e6313b24b49", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflows", + "password_reset_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"pending_request\",\n \"attributes\": {\n \"anim5\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ee9196d-e8ab-484a-9779-86559430bc88", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "password_reset_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "711e608a-b4ce-4ef3-9062-567d8dab3d75", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflows", + "password_reset_workflows" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow\": {\n \"profile_type_id\": \"\",\n \"status\": \"Enabled\",\n \"uid\": \"\",\n \"name\": \"\",\n \"options\": {\n \"expiration_time\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "workflow_actions", + "description": "", + "item": [ + { + "name": "approval_actions", + "description": "", + "item": [ + { + "id": "6382792b-8325-4cab-8ee5-02653633cd36", + "name": "Create an approval action", + "request": { + "name": "Create an approval action", + "description": { + "content": "Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "approval_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "b87433d7-9b6b-4b0d-957e-7a6d4dc4f515", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "approval_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "57cb73c1-829f-4a9c-94ff-9dc8387486a0", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "approval_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "205bc6e9-b46c-4a7b-8abc-956e75464ad4", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "approval_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "ask_security_question_actions", + "description": "", + "item": [ + { + "id": "5f0b1fbc-eb8d-4bb5-aee2-ff5514500bb9", + "name": "Create ask security question action", + "request": { + "name": "Create ask security question action", + "description": { + "content": "Create an ask security question action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "ask_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"number_of_questions\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"always\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "1001e044-24ca-48ae-9941-c667f1a76927", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "ask_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"number_of_questions\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"always\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "04c0d19e-6039-4bfb-81b4-93059cb839d4", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "ask_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"number_of_questions\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"always\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "dc24a762-6fef-4548-8573-c13b9d8372e0", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "ask_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"number_of_questions\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"always\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "auto_assign_actions", + "description": "", + "item": [ + { + "id": "655e1d2f-32f7-4df9-bc59-a115dca07c0b", + "name": "Create an auto assign action", + "request": { + "name": "Create an auto assign action", + "description": { + "content": "Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "auto_assign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"contributor_attr\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "599814b0-efb2-4616-b0fc-93217013b79d", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "auto_assign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"contributor_attr\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bfb9a0d2-996b-458e-9f80-5c19676e3db7", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "auto_assign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"contributor_attr\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "10f84f46-ae66-482a-8f3d-2ae4870372ba", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "auto_assign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"contributor_attr\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "batch_update_actions", + "description": "", + "item": [ + { + "id": "0c8e39b2-a332-4ca0-b5ba-037e7f20b49a", + "name": "Create a batch update action", + "request": { + "name": "Create a batch update action", + "description": { + "content": "Create a batch update action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "batch_update_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "d42293a8-b5f5-43c3-a0fc-9a21c1f92db1", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "batch_update_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a7bd8d3-7e7d-49dc-8b3b-592889b67167", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "batch_update_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d5b749aa-8b17-4f0b-a0dd-c352e0a0be19", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "batch_update_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "close_session_actions", + "description": "", + "item": [ + { + "id": "cabe7349-41f5-42f1-a87a-1e0acf587a4d", + "name": "Create a close session action", + "request": { + "name": "Create a close session action", + "description": { + "content": "Create a close session action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "close_session_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "21eec1a9-0814-4f5d-8108-6d8954c2fb40", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "close_session_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "91cc8f22-ca17-4afe-8753-ea050233072b", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "close_session_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d33adf2-d98e-4930-8f60-188a9f086d70", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "close_session_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "contributors_actions", + "description": "", + "item": [ + { + "id": "99c0bee3-8c84-4d5e-8ce2-ef473ecadaac", + "name": "Create a contributors action", + "request": { + "name": "Create a contributors action", + "description": { + "content": "Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "contributors_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"owner\": \"false\",\n \"contributors\": \"true\",\n \"roles\": \"true\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "79ebd007-cc90-4c6e-b8c5-549cfeb3d1de", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "contributors_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"owner\": \"false\",\n \"contributors\": \"true\",\n \"roles\": \"true\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bbccb1d3-afa8-41bc-8285-f138f6c1e5a6", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "contributors_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"owner\": \"false\",\n \"contributors\": \"true\",\n \"roles\": \"true\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3b6ed714-e45d-4760-8ce6-5817ad8080cb", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "contributors_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"owner\": \"false\",\n \"contributors\": \"true\",\n \"roles\": \"true\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "create_profile_actions", + "description": "", + "item": [ + { + "id": "3efd1c01-1119-4c05-ba2f-8b81f03fb47e", + "name": "Create a create profile action", + "request": { + "name": "Create a create profile action", + "description": { + "content": "Create a create profile action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "create_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"add_requester_as_owner\": true,\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "6230af61-8d5f-4076-a92b-a3d97bb2889c", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "create_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"add_requester_as_owner\": true,\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "14f4c368-0d4c-4907-8d04-ee4265c25daf", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "create_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"add_requester_as_owner\": true,\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "bdd00c71-6b52-4e43-a8a8-c1f056d538a8", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "create_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"add_requester_as_owner\": true,\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "duplicate_prevention_actions", + "description": "", + "item": [ + { + "id": "7ae58aa2-3969-4ad6-8848-191014bb034c", + "name": "Create a duplicate prevention action", + "request": { + "name": "Create a duplicate prevention action", + "description": { + "content": "Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "duplicate_prevention_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"search_scope\": \"current\",\n \"ne_attribute_ids\": \"\",\n \"handle_id\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "f2c610c6-8628-41fa-abee-a98e6c927f77", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "duplicate_prevention_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"search_scope\": \"current\",\n \"ne_attribute_ids\": \"\",\n \"handle_id\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "d91415a8-7fe9-4ca2-82e9-82e36a0a04b3", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "duplicate_prevention_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"search_scope\": \"current\",\n \"ne_attribute_ids\": \"\",\n \"handle_id\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "52dfb8c4-e0ee-47f1-9d87-a845896a36bc", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "duplicate_prevention_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"search_scope\": \"current\",\n \"ne_attribute_ids\": \"\",\n \"handle_id\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "email_verification_actions", + "description": "", + "item": [ + { + "id": "4d9e2c8d-eafd-463e-af68-cc4574aaac66", + "name": "Create an email verification action", + "request": { + "name": "Create an email verification action", + "description": { + "content": "Create an email verification action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "email_verification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_expiration\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"days\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "d35315d3-cc77-4768-9614-24d310e0b8d6", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "email_verification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_expiration\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"days\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ec2e1d93-4636-49d1-aed5-056d69116321", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "email_verification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_expiration\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"days\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7ea0ca4c-836b-4dc1-b4d8-804cf7e69cfe", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "email_verification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_expiration\": \"\",\n \"token_expiration\": \"\",\n \"token_expiration_type\": \"days\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "fulfillment_actions", + "description": "", + "item": [ + { + "id": "1c40663d-3a33-4ca6-b594-f1238cdfedae", + "name": "Create a fulfillment action", + "request": { + "name": "Create a fulfillment action", + "description": { + "content": "Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "fulfillment_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "002f706e-53ec-414d-a602-607bbc1c22b8", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "fulfillment_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2756e7a3-ea75-4d83-9ade-4140638220c5", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "fulfillment_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0190ae46-e1f0-4b85-accf-95da54732d93", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "fulfillment_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "identity_proofing_actions", + "description": "", + "item": [ + { + "id": "9da6491d-2001-42d7-9b82-0ab8bbeaef65", + "name": "Create an identity proofing action", + "request": { + "name": "Create an identity proofing action", + "description": { + "content": "Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "identity_proofing_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "0e8a2dfd-3795-487c-8901-c49bc9524516", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "identity_proofing_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "94ac8fce-6523-4a1f-8709-d070d08ce9e4", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "identity_proofing_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0d737e1-e311-4dde-8e28-8b4b93db1973", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "identity_proofing_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "invitation_actions", + "description": "", + "item": [ + { + "id": "5e5ba636-ca0d-4cfd-be13-c88559dd743e", + "name": "Create an invitation action", + "request": { + "name": "Create an invitation action", + "description": { + "content": "Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "invitation_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"wait_for_completion\": \"\",\n \"return_profile\": \"\",\n \"portal_id\": \"\",\n \"registration_workflow_id\": \"\",\n \"email_attribute_id\": \"\",\n \"validate_completed_registration\": \"\",\n \"validate_open_registration\": \"\"\n },\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"PerformerNotificationEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "d1270819-43fe-47ac-9aa7-5ee2f4c666f0", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "invitation_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"wait_for_completion\": \"\",\n \"return_profile\": \"\",\n \"portal_id\": \"\",\n \"registration_workflow_id\": \"\",\n \"email_attribute_id\": \"\",\n \"validate_completed_registration\": \"\",\n \"validate_open_registration\": \"\"\n },\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"PerformerNotificationEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b0b571df-b7de-4cde-b9d3-494de6646169", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "invitation_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"wait_for_completion\": \"\",\n \"return_profile\": \"\",\n \"portal_id\": \"\",\n \"registration_workflow_id\": \"\",\n \"email_attribute_id\": \"\",\n \"validate_completed_registration\": \"\",\n \"validate_open_registration\": \"\"\n },\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"PerformerNotificationEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "a132470e-2b69-4dcf-aa18-bf5ddfc8782a", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "invitation_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"wait_for_completion\": \"\",\n \"return_profile\": \"\",\n \"portal_id\": \"\",\n \"registration_workflow_id\": \"\",\n \"email_attribute_id\": \"\",\n \"validate_completed_registration\": \"\",\n \"validate_open_registration\": \"\"\n },\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"PerformerNotificationEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "ldap_actions", + "description": "", + "item": [ + { + "id": "35bd2f73-2a04-44e1-8c7b-b8b6f3608388", + "name": "Create a ldap action", + "request": { + "name": "Create a ldap action", + "description": { + "content": "Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "ldap_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"store_type\": \"Local\",\n \"ldap_action_user_roles_attributes\": {\n \"id\": \"\",\n \"role_id\": \"\"\n },\n \"workflow_action_value_builders_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"value_builder_id\": \"\",\n \"position\": \"\"\n },\n \"workflow_action_directory_groups_attributes\": {\n \"id\": \"\",\n \"directory_id\": \"\",\n \"group_label\": \"\",\n \"group_dn\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "9aeb22bc-b73e-403a-9627-b58686b37308", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "ldap_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"store_type\": \"Local\",\n \"ldap_action_user_roles_attributes\": {\n \"id\": \"\",\n \"role_id\": \"\"\n },\n \"workflow_action_value_builders_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"value_builder_id\": \"\",\n \"position\": \"\"\n },\n \"workflow_action_directory_groups_attributes\": {\n \"id\": \"\",\n \"directory_id\": \"\",\n \"group_label\": \"\",\n \"group_dn\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9cf30cfe-9ed9-41b0-9c55-ae2c28e363fd", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "ldap_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"store_type\": \"Local\",\n \"ldap_action_user_roles_attributes\": {\n \"id\": \"\",\n \"role_id\": \"\"\n },\n \"workflow_action_value_builders_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"value_builder_id\": \"\",\n \"position\": \"\"\n },\n \"workflow_action_directory_groups_attributes\": {\n \"id\": \"\",\n \"directory_id\": \"\",\n \"group_label\": \"\",\n \"group_dn\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0223fc28-4a57-42b2-b378-3ac42feb4c99", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "ldap_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"store_type\": \"Local\",\n \"ldap_action_user_roles_attributes\": {\n \"id\": \"\",\n \"role_id\": \"\"\n },\n \"workflow_action_value_builders_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"value_builder_id\": \"\",\n \"position\": \"\"\n },\n \"workflow_action_directory_groups_attributes\": {\n \"id\": \"\",\n \"directory_id\": \"\",\n \"group_label\": \"\",\n \"group_dn\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "notification_actions", + "description": "", + "item": [ + { + "id": "a6998dad-16f9-4aee-afff-6feeeab1affa", + "name": "Create a notification action", + "request": { + "name": "Create a notification action", + "description": { + "content": "Create a notification action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "notification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"archived\": false,\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"StandardEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "b49777dc-2cdb-4b84-b5f6-02749860a15d", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "notification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"archived\": false,\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"StandardEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5edaca55-a50e-4cdd-a21b-dda55853ad92", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "notification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"archived\": false,\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"StandardEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "87732344-a659-46d1-a89f-c2166fb303b8", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "notification_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"archived\": false,\n \"workflow_action_email_attributes\": {\n \"id\": \"\",\n \"workflow_action_id\": \"\",\n \"email_id\": \"\",\n \"type\": \"StandardEmail\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "password_reset_actions", + "description": "", + "item": [ + { + "id": "c84763aa-ea19-4bca-aeec-6b374b46aac5", + "name": "Create a password reset action", + "request": { + "name": "Create a password reset action", + "description": { + "content": "Create a password reset action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "password_reset_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "e464113d-3ca9-4aeb-ba0c-0bdefc251af7", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "password_reset_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1af65a1c-0d5b-45fc-a2a1-6436fb200b7f", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "password_reset_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ff6ae630-1972-4aaf-8ea9-c509484421bc", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "password_reset_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "profile_check_actions", + "description": "", + "item": [ + { + "id": "6fd7cc4a-8f68-426b-ac16-831d46cb14e8", + "name": "Create a profile check action", + "request": { + "name": "Create a profile check action", + "description": { + "content": "Create a profile check action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "profile_check_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"ne_attribute_ids\": \"\",\n \"handle_type\": \"session\",\n \"handle_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "5c3a2926-aae2-45b4-a39a-8c4a40ac84b8", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "profile_check_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"ne_attribute_ids\": \"\",\n \"handle_type\": \"session\",\n \"handle_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9dbcf0af-9237-4edd-a576-bb765fce4ac6", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "profile_check_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"ne_attribute_ids\": \"\",\n \"handle_type\": \"session\",\n \"handle_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0ab7818f-9def-4e30-912c-801b406711d1", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "profile_check_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"ne_attribute_ids\": \"\",\n \"handle_type\": \"session\",\n \"handle_id\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "profile_select_actions", + "description": "", + "item": [ + { + "id": "82e1f498-51ee-4a6a-8a02-443e1f28cdd3", + "name": "Create a profile select action", + "request": { + "name": "Create a profile select action", + "description": { + "content": "Create a profile select action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "profile_select_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "275dc4f9-c574-44c8-91f1-54349f21de2e", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "profile_select_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "9441fc9d-6ce1-4079-aca3-d4dcd65eeed7", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "profile_select_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "b6b159f3-3025-469e-8004-d47853cb4c4b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "profile_select_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "request_actions", + "description": "", + "item": [ + { + "id": "ae909400-bf73-4fe0-98cd-8d6a3c927b35", + "name": "Create a request action", + "request": { + "name": "Create a request action", + "description": { + "content": "Create a request action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "request_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "dc7868c8-e08d-4d8e-b238-9af2dd568e8b", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "request_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "28561f69-3ebd-4abc-a1d3-594568523bca", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "request_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ce6c93ae-9620-4fd3-be91-c4ec563483cf", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "request_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "rest_api_actions", + "description": "", + "item": [ + { + "id": "81245c02-1357-4af1-968a-c53cefa749d4", + "name": "Create a REST API action", + "request": { + "name": "Create a REST API action", + "description": { + "content": "Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "rest_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "f0172512-a9f4-4825-9362-793dd48fa4b1", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "rest_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "1c3bd046-c3a8-41ef-ab59-e305d212f7e6", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "rest_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f1d34c7c-31e5-4aa7-be7d-d3ff59e263fc", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "rest_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "review_actions", + "description": "", + "item": [ + { + "id": "cc6c9b47-a60b-4267-91a1-e05b010ce2b9", + "name": "Create a review action", + "request": { + "name": "Create a review action", + "description": { + "content": "Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "review_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "c8a1062a-13b5-4511-be5e-d8f3d793118f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "review_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "611ab95c-7946-47ea-910c-a9a5a6d2cb94", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "review_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6a73dd8a-9ae1-42d9-8a68-077630eb62fd", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "review_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"archived\": false,\n \"requires_comment\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "run_workflow_actions", + "description": "", + "item": [ + { + "id": "89be4a0b-2bca-42c5-96fd-8a1e334b8db5", + "name": "Create a run workflow action", + "request": { + "name": "Create a run workflow action", + "description": { + "content": "Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "run_workflow_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"workflow_id\": \"\",\n \"wait_for_completion\": \"\",\n \"profile_to_send\": \"none\",\n \"return_profile\": \"\",\n \"run_workflow_action_id\": \"\",\n \"profile_type_id\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "d97598a8-bd84-4049-8f98-0a9d0dd54109", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "run_workflow_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"workflow_id\": \"\",\n \"wait_for_completion\": \"\",\n \"profile_to_send\": \"none\",\n \"return_profile\": \"\",\n \"run_workflow_action_id\": \"\",\n \"profile_type_id\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "814fed1d-177c-4ef2-910d-fb251d389f9e", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "run_workflow_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"workflow_id\": \"\",\n \"wait_for_completion\": \"\",\n \"profile_to_send\": \"none\",\n \"return_profile\": \"\",\n \"run_workflow_action_id\": \"\",\n \"profile_type_id\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8ef959a2-af98-4600-a6fb-8b200f7b60bc", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "run_workflow_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"configuration_attributes\": {\n \"id\": \"\",\n \"workflow_id\": \"\",\n \"wait_for_completion\": \"\",\n \"profile_to_send\": \"none\",\n \"return_profile\": \"\",\n \"run_workflow_action_id\": \"\",\n \"profile_type_id\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "set_attributes_actions", + "description": "", + "item": [ + { + "id": "58d445ff-4d0f-4800-b199-ddce6022c55b", + "name": "Create a set attributes action", + "request": { + "name": "Create a set attributes action", + "description": { + "content": "Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "set_attributes_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "a30c3045-fd51-41f3-bb8d-ac330b9fdf3e", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "set_attributes_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2673e24d-edb0-4673-acab-02d6b7ae864c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "set_attributes_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "abc93dbd-a8d3-472e-b783-75e55f7471a0", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "set_attributes_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "set_security_question_actions", + "description": "", + "item": [ + { + "id": "f563a6f9-5192-45d3-8325-575d09334029", + "name": "Create set security question action", + "request": { + "name": "Create set security question action", + "description": { + "content": "Create a set security question action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "set_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"number_of_questions\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "8ac75a0a-d44a-4cbe-854a-1a8ba1dc8f69", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "set_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"number_of_questions\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7e8c1b23-f33c-409d-94f5-ab65e234fce3", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "set_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"number_of_questions\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "810057f8-2dee-4247-b3da-4948b93439ac", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "set_security_question_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false,\n \"number_of_questions\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "soap_api_actions", + "description": "", + "item": [ + { + "id": "dc921a8b-ae23-4c0c-8f03-0e4e29e94cb6", + "name": "Create a SOAP API action", + "request": { + "name": "Create a SOAP API action", + "description": { + "content": "Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "soap_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "880635a0-a024-49fd-84aa-153df7ca879f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "soap_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "92123fca-ddcb-42a3-bbfc-38af8d6a3f75", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "soap_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "6e1c6c01-de0c-415d-9163-eaf6725e8ab2", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "soap_api_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "status_change_actions", + "description": "", + "item": [ + { + "id": "bca65369-16a9-412f-bec1-4787e35e55b6", + "name": "Create a status change action", + "request": { + "name": "Create a status change action", + "description": { + "content": "Create a status change action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "status_change_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"new_status\": \"On Leave\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "0c7c0ebf-81a4-4149-ae75-7fdb55d4529b", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "status_change_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"new_status\": \"On Leave\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c7e7f306-444f-4fb9-8754-6dec68c37e9c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "status_change_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"new_status\": \"On Leave\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e90d21a9-8e48-447b-b4fb-0b908c31a86b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "status_change_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"new_status\": \"On Leave\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "unassign_actions", + "description": "", + "item": [ + { + "id": "2734dac5-c23b-4259-baa0-45a6cadfc241", + "name": "Create an unassign action", + "request": { + "name": "Create an unassign action", + "description": { + "content": "Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "unassign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "f70ed748-d32d-47fa-a91e-61d047220869", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "unassign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7a43b359-941b-4d41-98f5-cf995693abd3", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "unassign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "18144afd-01a8-4adb-a8a8-27b8f54a229f", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "unassign_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "update_profile_actions", + "description": "", + "item": [ + { + "id": "301a9546-db13-4e04-b1b6-41e607984151", + "name": "Create an update profile action", + "request": { + "name": "Create an update profile action", + "description": { + "content": "Create an update profile action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "update_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "8c051be6-6256-4745-a876-b2ed5248bf73", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "update_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cafcc389-3daf-4aaf-8c5b-8dd6212a78c8", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "update_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "2cee0363-d191-4799-a83f-ae84d8038931", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "update_profile_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "username_password_actions", + "description": "", + "item": [ + { + "id": "6bcbff53-ad50-492b-bd21-f41639e783a1", + "name": "Create a username password action", + "request": { + "name": "Create a username password action", + "description": { + "content": "Create a username password action", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_actions", + "username_password_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "872e2816-db79-425f-b444-fac337558c5f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "username_password_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"page_id\": \"\",\n \"add_requester_as_owner\": true,\n \"email_attribute_id\": \"\",\n \"email_addresses\": [\n \"\",\n \"\"\n ],\n \"new_status\": \"\",\n \"archived\": false,\n \"skippable\": false,\n \"requires_comment\": false\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae4c8f59-a567-48ef-a34f-222c28e72e04", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "username_password_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0c5ba472-6b8e-4696-afab-876c4814911b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_actions", + "username_password_actions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_action\": {\n \"workflow_id\": \"\",\n \"description\": \"\",\n \"archived\": false\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + }, + { + "name": "workflow_sessions", + "description": "", + "item": [ + { + "id": "7a3fac0b-9b70-4236-9b9b-f35a2a5b2393", + "name": "Get workflow sessions", + "request": { + "name": "Get workflow sessions", + "description": { + "content": "Get workflow sessions", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow session uid for filtering", + "type": "text/plain" + }, + "key": "uid", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow ID for filtering", + "type": "text/plain" + }, + "key": "workflow_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Requester ID for filtering", + "type": "text/plain" + }, + "key": "requester_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "filter by workflow session status", + "type": "text/plain" + }, + "key": "status", + "value": "requested" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "4c00d53a-4da6-4b33-9739-5099782b4335", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow session uid for filtering", + "type": "text/plain" + }, + "key": "uid", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow ID for filtering", + "type": "text/plain" + }, + "key": "workflow_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Requester ID for filtering", + "type": "text/plain" + }, + "key": "requester_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "filter by workflow session status", + "type": "text/plain" + }, + "key": "status", + "value": "requested" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_sessions\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeaccessUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"non_employee_updated\",\n \"attributes\": {\n \"Duis_96\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeprofileUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"AUTH-STATUS4\",\n \"attributes\": {\n \"dolor_38\": \"\",\n \"deserunt7\": \"\"\n }\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "16ebe82f-a985-40c5-95aa-cd05c8fd5b5e", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow session uid for filtering", + "type": "text/plain" + }, + "key": "uid", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow ID for filtering", + "type": "text/plain" + }, + "key": "workflow_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Requester ID for filtering", + "type": "text/plain" + }, + "key": "requester_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "filter by workflow session status", + "type": "text/plain" + }, + "key": "status", + "value": "requested" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3ada4916-b13e-4d41-b656-ae233c6ac37b", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow session uid for filtering", + "type": "text/plain" + }, + "key": "uid", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow ID for filtering", + "type": "text/plain" + }, + "key": "workflow_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Requester ID for filtering", + "type": "text/plain" + }, + "key": "requester_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "filter by workflow session status", + "type": "text/plain" + }, + "key": "status", + "value": "requested" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "b4e21029-3ab5-4b27-a223-ae945f89576a", + "name": "Create a workflow session", + "request": { + "name": "Create a workflow session", + "description": { + "content": "Create a workflow session", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"attributes\": {\n \"ipsum9de\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "62121996-cf09-4a80-80aa-294bce993b13", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"attributes\": {\n \"ipsum9de\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_session\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeaccessUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"status_changed\",\n \"attributes\": {\n \"in_2\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "cc9ad035-0b9a-4e2d-8b65-67b7aa9fe808", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"attributes\": {\n \"ipsum9de\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "20b1fc12-0479-44de-bf1f-e9499a7843ab", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"attributes\": {\n \"ipsum9de\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "e5ec8505-2f8b-4f5c-998c-92b31f24a52f", + "name": "Find workflow session by id", + "request": { + "name": "Find workflow session by id", + "description": { + "content": "Find workflow session by id", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "b59ea64e-0c53-4f7d-8363-c2583b4e1b71", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_session\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeaccessUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"status_changed\",\n \"attributes\": {\n \"in_2\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "fb9e2a4a-d6b8-45cb-83fc-595d4b106528", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "42d50412-f2eb-43b5-8a38-cf16a96d6f4c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "e744b56f-9319-4dcd-b5d9-d6b4ae481830", + "name": "Update a workflow session by id", + "request": { + "name": "Update a workflow session by id", + "description": { + "content": "Update a workflow session by id", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"reviewed\",\n \"attributes\": {\n \"irure_ad1\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "0773adad-a800-4b6c-9c48-a164abcaaa2d", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"reviewed\",\n \"attributes\": {\n \"irure_ad1\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"workflow_session\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"NeaccessUser\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"status_changed\",\n \"attributes\": {\n \"in_2\": \"\"\n }\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "24585259-966d-4fda-b261-7892019a9e34", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"reviewed\",\n \"attributes\": {\n \"irure_ad1\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "7b645715-2e6c-408f-b686-70727e3a4126", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Will run the created/updated workflow session if successful", + "type": "text/plain" + }, + "key": "run", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"workflow_session\": {\n \"workflow_id\": \"\",\n \"requester_id\": \"\",\n \"requester_type\": \"User\",\n \"profile_id\": \"\",\n \"profile_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"reviewed\",\n \"attributes\": {\n \"irure_ad1\": \"\"\n }\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "upload", + "description": "", + "item": [ + { + "name": "{attribute_id}", + "description": "", + "item": [ + { + "id": "23916ca5-45d8-4ca2-9344-32d648a9a1b2", + "name": "Retrieves the URL of an attachment attribute value from a workflow session", + "request": { + "name": "Retrieves the URL of an attachment attribute value from a workflow session", + "description": { + "content": "Retrieves the URL of an attachment attribute value from a workflow session", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attribute_id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "ab807b64-bea9-4790-aee9-7be57dc5fb57", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "91303b3c-3ed9-467a-93f8-e91d3ec0e1ef", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8a0fa76b-ade1-4798-81ad-3b6b48abcdbe", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "298592eb-bc6f-4a98-b294-1db7eb0db416", + "name": "Uploads a new attachment attribute value to a workflow session", + "request": { + "name": "Uploads a new attachment attribute value to a workflow session", + "description": { + "content": "Uploads a new attachment attribute value to a workflow session", + "type": "text/plain" + }, + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + }, + { + "type": "any", + "value": "", + "key": "attribute_id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + }, + "auth": null + }, + "response": [ + { + "id": "317b99c7-c31d-4587-a7bc-79f0adcc681b", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"url\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5d3e241b-9db1-4e7f-8c51-060d5ed250c7", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "38bb536a-32b2-465d-acde-2edabdc2ec7c", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "workflow_sessions", + ":id", + "upload", + ":attribute_id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "", + "type": "text/plain" + }, + "key": "file", + "value": "", + "type": "text" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "identity_proofing_results", + "description": "", + "item": [ + { + "id": "738ec9f9-511e-41f3-9a8c-1e090d1dcb4b", + "name": "Get identity proofing result data in bulk", + "request": { + "name": "Get identity proofing result data in bulk", + "description": { + "content": "This endpoint can retrieve identity proofing result data in bulk from Lifecycle", + "type": "text/plain" + }, + "url": { + "path": [ + "identity_proofing_results" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow Session ID to filter by", + "type": "text/plain" + }, + "key": "workflow_session_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID Proofing Result to filter by", + "type": "text/plain" + }, + "key": "result", + "value": "pass" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "d6df8d55-53b6-43a0-b901-ebb23e234570", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "identity_proofing_results" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Profile ID to filter by", + "type": "text/plain" + }, + "key": "profile_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Workflow Session ID to filter by", + "type": "text/plain" + }, + "key": "workflow_session_id", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "ID Proofing Result to filter by", + "type": "text/plain" + }, + "key": "result", + "value": "pass" + }, + { + "disabled": false, + "description": { + "content": "Returns batching metadata in the response", + "type": "text/plain" + }, + "key": "metadata", + "value": "false" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity_proofing_results\": [\n {\n \"id\": \"\",\n \"identity_proofing_action_id\": \"\",\n \"workflow_session_id\": \"\",\n \"profile_id\": \"\",\n \"proofing_workflow\": \"\",\n \"result\": \"pending\",\n \"proofing_attributes\": {\n \"pariatur__\": \"\",\n \"velite6\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"identity_proofing_action_id\": \"\",\n \"workflow_session_id\": \"\",\n \"profile_id\": \"\",\n \"proofing_workflow\": \"\",\n \"result\": \"pending\",\n \"proofing_attributes\": {\n \"enim7f\": \"\",\n \"dolor_\": \"\",\n \"pariatur1\": \"\",\n \"exercitation619\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"_metadata\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "advanced_search", + "description": "", + "item": [ + { + "id": "94601be4-10c7-427b-9f56-0fe1353f202f", + "name": "Get saved advanced search queries", + "request": { + "name": "Get saved advanced search queries", + "description": { + "content": "Get saved advanced search queries", + "type": "text/plain" + }, + "url": { + "path": [ + "advanced_search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "aa08bb88-391d-480b-b05c-9ce190fe8b86", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "advanced_search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"advanced_search\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "f171fb10-482d-4abb-897e-63be6c5a2fa2", + "name": "Save an advanced search query for later use", + "request": { + "name": "Save an advanced search query for later use", + "description": { + "content": "Save an advanced search query for later use", + "type": "text/plain" + }, + "url": { + "path": [ + "advanced_search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"advanced_search\": {\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n },\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "7e4fb77a-7fb6-4c6d-82da-ae4593e78b42", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "advanced_search" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"advanced_search\": {\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n },\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"advanced_search\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "run", + "description": "", + "item": [ + { + "id": "f7c9da50-639c-41d9-a8ae-d6c444e4d8d9", + "name": "Run an advanced search for profiles, without saving the query", + "request": { + "name": "Run an advanced search for profiles, without saving the query", + "description": { + "content": "Run an advanced search for profiles, without saving the query", + "type": "text/plain" + }, + "url": { + "path": [ + "advanced_search", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"advanced_search\": {\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n },\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "12c46dd9-6707-4d2f-ab9c-be31695f0024", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "advanced_search", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"advanced_search\": {\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n },\n {\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"dolore_0\": \"\",\n \"consequat17c\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"ipsumb8\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "{id}", + "description": "", + "item": [ + { + "id": "af0a0397-81bd-4d19-b6e3-638a99ac4e66", + "name": "Update a saved advanced search query", + "request": { + "name": "Update a saved advanced search query", + "description": { + "content": "Update a saved advanced search query", + "type": "text/plain" + }, + "url": { + "path": [ + "advanced_search", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced_search\": {\n \"id\": \"\",\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"id\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\",\n \"_destroy\": false\n },\n {\n \"id\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\",\n \"_destroy\": false\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "de18743e-45f9-4764-8531-c28f4b9fb161", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "advanced_search", + ":id" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "PATCH", + "body": { + "mode": "raw", + "raw": "{\n \"advanced_search\": {\n \"id\": \"\",\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"id\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\",\n \"_destroy\": false\n },\n {\n \"id\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\",\n \"_destroy\": false\n }\n ]\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"advanced_search\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"label\": \"\",\n \"condition_rules_attributes\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"!=\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"type\": \"ProfileTypeRule\",\n \"comparison_operator\": \"==\",\n \"value\": \"\"\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "name": "run", + "description": "", + "item": [ + { + "id": "61d72718-c1be-4b7e-8ad9-0a61619bd7c4", + "name": "Run a saved advanced search query", + "request": { + "name": "Run a saved advanced search query", + "description": { + "content": "Run a saved advanced search query", + "type": "text/plain" + }, + "url": { + "path": [ + "advanced_search", + ":id", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "id", + "disabled": false + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "f987db2f-7456-4ce1-8ac1-0b49f5168d82", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "advanced_search", + ":id", + "run" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[limit]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[offset]", + "value": "" + }, + { + "disabled": false, + "description": { + "content": "Allows for pagination and sorting.", + "type": "text/plain" + }, + "key": "query[order]", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"profiles\": [\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"fail\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"dolore_0\": \"\",\n \"consequat17c\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"profile_type_id\": \"\",\n \"status\": \"Terminated\",\n \"id_proofing_status\": \"pending\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"attributes\": {\n \"ipsumb8\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ] + } + ] + }, + { + "name": "job_status", + "description": "", + "item": [ + { + "id": "516a2517-1870-4eca-9f96-2e14b8b5ad18", + "name": "Get the status of a bulk job", + "request": { + "name": "Get the status of a bulk job", + "description": { + "content": "Get the status of a bulk job", + "type": "text/plain" + }, + "url": { + "path": [ + "job_status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) The id of the job returned from a POST or PATCH endpoint that resulted in a job being created", + "type": "text/plain" + }, + "key": "job_id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ + { + "id": "b756d4a5-0ce2-474d-9dc2-14a35e6d5daf", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "job_status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) The id of the job returned from a POST or PATCH endpoint that resulted in a job being created", + "type": "text/plain" + }, + "key": "job_id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"uid\": \"\",\n \"status\": \"\",\n \"job_type\": \"\",\n \"job_data\": [\n {\n \"user_id\": \"\",\n \"manager_id\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n },\n {\n \"user_id\": \"\",\n \"manager_id\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "e31315d4-0892-4be8-a800-4fa6bfe105b1", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "job_status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) The id of the job returned from a POST or PATCH endpoint that resulted in a job being created", + "type": "text/plain" + }, + "key": "job_id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "c0b3ee16-e409-4de8-a3d1-2ffd13033441", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "job_status" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": false, + "description": { + "content": "(Required) The id of the job returned from a POST or PATCH endpoint that resulted in a job being created", + "type": "text/plain" + }, + "key": "job_id", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "GET", + "body": {} + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "forms", + "description": "", + "item": [ + { + "id": "d99db05d-1c45-4f5a-8dcf-1c5a886c8ef4", + "name": "Create a form", + "request": { + "name": "Create a form", + "description": { + "content": "This endpoint can create a form", + "type": "text/plain" + }, + "url": { + "path": [ + "forms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "3eb16fc0-0277-4093-a708-17cbaf1289e7", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "forms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"form\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\",\n \"id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "53c16c8c-d382-4dbe-8a73-da215318775c", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "forms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "5cbb96a1-9d89-42f0-b976-ec0559d1147f", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "forms" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form\": {\n \"uid\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"archived\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "form_attributes", + "description": "", + "item": [ + { + "id": "f9ff76eb-20f4-49c4-ab8e-2cf535977a6a", + "name": "Create a form attribute", + "request": { + "name": "Create a form attribute", + "description": { + "content": "This endpoint can create a form attribute", + "type": "text/plain" + }, + "url": { + "path": [ + "form_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form_attribute\": {\n \"form_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"attr_type\": \"break\",\n \"order\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "81574b80-3d44-4ade-9594-f7cc104b947f", + "name": "Expected response to a valid request", + "originalRequest": { + "url": { + "path": [ + "form_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form_attribute\": {\n \"form_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"attr_type\": \"break\",\n \"order\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"form_attribute\": {\n \"form_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"attr_type\": \"break\",\n \"order\": \"\",\n \"id\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ae1da410-cb7f-4e2d-9171-af663c5b9375", + "name": "Bad Request - unable to complete.", + "originalRequest": { + "url": { + "path": [ + "form_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form_attribute\": {\n \"form_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"attr_type\": \"break\",\n \"order\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Bad Request", + "code": 400, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"example\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "8d634ce4-b030-47f3-a6cc-4806138fa0bb", + "name": "Internal Server Error - returned on unhandled exceptions.", + "originalRequest": { + "url": { + "path": [ + "form_attributes" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": { + "content": "Added as a part of security scheme: bearer", + "type": "text/plain" + }, + "key": "Authorization", + "value": "Bearer " + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"form_attribute\": {\n \"form_id\": \"\",\n \"ne_attribute_id\": \"\",\n \"attr_type\": \"break\",\n \"order\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"error\": {\n \"description\": \"A message describing the error\",\n \"example\": \"Sorry something went wrong\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "type": "any", + "value": "{{bearerToken}}", + "key": "token" + } + ] + }, + "event": [], + "variable": [ + { + "key": "tenantName", + "value": "acmeco" + }, + { + "key": "baseUrl", + "value": "https://{{tenantName}}.nonemployee.com/api" + } + ], + "info": { + "_postman_id": "b3daab6f-d859-48f9-91df-ebd25c106893", + "name": "NERM API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": { + "content": "The NERM API can be used to access and modify various resources in your environment.", + "type": "text/plain" + } + } +} \ No newline at end of file diff --git a/postman/links/nerm-link.txt b/postman/links/nerm-link.txt new file mode 100644 index 0000000..ccaeea0 --- /dev/null +++ b/postman/links/nerm-link.txt @@ -0,0 +1 @@ +https://god.gw.postman.com/run-collection/23226990-57d2b8dd-9610-4b3e-a306-f39d74a91985?action=collection%2Ffork&collection-url=entityId%3D23226990-57d2b8dd-9610-4b3e-a306-f39d74a91985%26entityType%3Dcollection%26workspaceId%3D80af54be-a333-4712-af5e-41aa9eccbdd0 \ No newline at end of file