{ "openapi": "3.1.0", "info": { "title": "Worker Management", "version": "2023-07-01" }, "servers": [ { "url": "https://client.beeline.com/api" }, { "url": "https://client-eu.beeline.com/api" } ], "tags": [ { "name": "Assignment", "description": "Streamline the assignment lifecycle by managing provisioning, deprovisioning, and updating assignment data. Click [here](webhook-management_2023-07-01#tag/assignment-event-types) to see the list of assignment events that are available to subscribe to." }, { "name": "Candidate", "description": "Enable provisioning and onboarding through managing candidate data. Click [here](webhook-management_2023-07-01#tag/candidate-event-types) to see the list of available candidate events that are available to subscribe to." }, { "name": "Request", "description": "Enable provisioning and onboarding through managing request data. Click [here](webhook-management_2023-07-01#tag/request-event-types) to see the list of available request events that are available to subscribe to." }, { "name": "Worker", "description": "Enable worker onboarding and offboarding through retrieving Worker information. Click [here](webhook-management_2023-07-01#tag/worker-event-types) to see the list of available worker events that are available to subscribe to." } ], "paths": { "/sites/{clientSiteId}/assignments/{assignmentId}/client-defined-values/{fieldId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "fieldId", "description": "Uniquely identifies an field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-client-defined-value-field-by-assignment-id-and-field-id", "summary": "Assignment Client Defined Field Value", "description": "Retrieves CDF and CDV setup in Enterprise with a given assignment ID and field ID.\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "read:client-defined" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } }, "examples": { "client-defined-value-string-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" } }, "client-defined-value-text-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" } }, "client-defined-value-int-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 } }, "client-defined-value-money-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 } }, "client-defined-value-date-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" } }, "client-defined-value-checkbox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkBox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true } }, "client-defined-value-single-selector-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } } }, "client-defined-value-dropdown-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } } }, "client-defined-value-shufflebox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}/client-defined-value-amendments": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "amend-assignment-cdvs", "summary": "Amend Assignment Client Defined Values", "description": "Submits a request to amend assignment client defined values\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "write:assignment" ] } ], "requestBody": { "description": "The assignment client defined values amendment details", "content": { "application/json": { "schema": { "type": "object", "description": "The amend assignment request details.", "required": [ "amendmentEffectiveDate" ], "properties": { "amendmentEffectiveDate": { "type": "string", "format": "date", "description": "- The effective date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "amendmentEndDate": { "type": "string", "format": "date", "description": "- The end date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "clientDefinedValues": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "value": { "description": "Value of the client defined field.\n- If a fieldId is provided and no value, then the value will be cleared.\n- multipleItemValues will overwrite what exists. e.g. providing an empty array will deselect all items.\n- Only CDVs sent in the request body will be updated. Any field not included will retain its value.\n- Update of attachments and single selector is not supported at this time.\n", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "string", "format": "uuid", "title": "dropdown", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, { "type": "array", "title": "shufflebox", "description": "An array of unique identifiers for the items selected in a shufflebox of the client defined field.", "items": { "type": "string", "format": "uuid" } } ] } } }, "description": "Client defined values to be updated." }, "comment": { "type": "string", "description": "The comment regarding the amendment of the assignment.", "maxLength": 1024 } } }, "examples": { "amend-assignment-cdvs-request": { "value": { "amendmentEffectiveDate": "2023-01-18", "amendmentEndDate": "2023-01-18", "clientDefinedValues": [ { "fieldId": "111111-2222-3333-4444-555555555555", "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": 100.5 }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": "111111-2222-3333-4444-555555555555" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": { "items": [ "111111-2222-3333-4444-555555555555", "111111-2222-3333-4444-555555555555" ] } } ], "comment": "Example string comment" } } } } } }, "responses": { "202": { "description": "Accepted", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "The assignment accepted response details.", "required": [ "processId" ], "properties": { "processId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment amendment process instance." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}/client-defined-values": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "get": { "operationId": "get-client-defined-values-by-assignment-id", "summary": "Assignment Client Defined Values List", "description": "Retrieves a list of client-defined values (CDVs) for a specific assignment.\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "read:client-defined" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of client defined values for the given id.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } } } } }, "examples": { "client-defined-value-list": { "value": { "maxItems": 9, "value": [ { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkbox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/assignment-numbers/{assignmentNumber}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentNumber", "description": "The assignment number that uniquely identifies an assignment", "required": true, "schema": { "type": "integer" }, "example": 1 }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-assignment-id-by-number", "summary": "Assignment Id By Number", "description": "Provides an assignment Id by assignment number\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "read:assignment" ] } ], "responses": { "200": { "description": "An assignment Id", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "An assignment Id", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } }, { "name": "userId", "in": "query", "description": "Uniquely identifies a user.", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "statusType", "in": "query", "description": "Uniquely identifies an assignment status.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "active", "cancel", "expired", "pending", "rejected", "scheduled", "void" ] } } } ], "get": { "operationId": "get-assignment-list", "summary": "Assignment List", "description": "Retrieves a list of all assignments or a list of assignments for specific assignment statuses and/or worker.\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "read:assignment" ] } ], "parameters": [ { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "responses": { "200": { "description": "A list of assignments", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of assignments", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of assignments" }, "value": { "type": "array", "description": "An array of assignments. If there are no assignments, this will be an empty array.", "items": { "type": "object", "description": "Current state for an assignment.", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "statusType": { "type": "string", "enum": [ "active", "cancel", "expired", "pending", "rejected", "scheduled", "void" ], "description": "The status of this assignment.\n" } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-assignment-by-id", "summary": "Assignment", "description": "Retrieves current assignment information\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "read:assignment" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Current state for an assignment.", "required": [ "assignmentId", "assignmentDetailId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "assignmentDetailId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment detail.\n", "example": "7a40445f-7b8f-4cef-aa10-72f6cb889eb1" }, "assignmentNumber": { "type": "integer", "description": "The number of the assignment.\n", "example": 34593745 }, "procurementType": { "type": "string", "enum": [ "contingent", "permanent", "project", "services" ], "description": "The procurement type of the assignment.\n", "example": "Contingent" }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "jobTitle": { "type": "object", "required": [ "jobTitleId" ], "description": "The job title associated with this assignment.\n", "properties": { "jobTitleId": { "type": "string", "format": "uuid", "description": "The unique identifier of the job title.\n" }, "jobTitleName": { "type": "string", "description": "The name of the job title.\n" } } }, "hiringManager": { "type": "object", "description": "The hiring manager associated with this assignment.\n", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the hiring manager.\n" }, "userName": { "type": "string", "description": "The username of the hiring manager.\n" } } }, "billToCostCenter": { "description": "The bill to cost center associated with this assignment.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "adminCostCenter": { "description": "The admin cost center associated with this assignment.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "taxLocation": { "description": "The location where taxes are applied.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "physicalWorkLocation": { "description": "The work location for this assignment.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "worker": { "type": "object", "description": "The specific worker for this assignment.\n", "required": [ "userId", "resourceId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the worker.\n" }, "resourceId": { "type": "string", "format": "uuid", "description": "The worker's resource unique identifier.\n" }, "userName": { "type": "string", "description": "The userName of this worker.\n" } } }, "supplier": { "description": "The associated supplier to this assigment.", "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "type": "string", "format": "uuid", "description": "The unique identifier of the supplier.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "supplierCode": { "type": "string", "description": "The code for this supplier.", "maxLength": 50, "example": "code123" } } }, "statusType": { "type": "string", "enum": [ "expired", "active", "scheduled", "cancel", "void", "pending", "rejected" ], "description": "The status of this assignment.\n" }, "substatus": { "type": "string", "maxLength": 255, "description": "Standard Beeline names: {:@CUAssignmentSubStatusCancelled}, {:@CUAssignmentSubStatusNoShow},\n{:@CUAssignmentSubStatusExtensionProgress}, {:@CUAssignmentSubStatusCancellationProgress},\n{:@CUAssignmentSubStatusReopened}, {:@CUAssignmentSubStatusAmendmentProgress},\n{:@CUAssignmentSubStatusNA}, {:@CUAssignmentSubStatusTerminationProgress}\n\nThe substatus name of the assignment. This can be a standard Beeline substatus name\nor an added customer value.\n" }, "requestorUserId": { "type": "string", "format": "uuid", "description": "The unique identifier of the requestor." }, "sponsorUserId": { "type": "string", "format": "uuid", "description": "The unique identifier of the sponsor." }, "requestId": { "type": "string", "format": "uuid", "description": "The unique identifier of the request." }, "businessArea": { "type": "object", "required": [ "businessAreaId" ], "description": "The business area associated with this assignment.\n", "properties": { "businessAreaId": { "type": "string", "format": "uuid", "description": "The business area ID associated with this assignment.\n" }, "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area.", "maxLength": 255, "example": "BA123" } } }, "functionalPartition": { "type": "object", "required": [ "functionalPartitionId" ], "description": "The functional partition associated with this assignment.\n", "properties": { "functionalPartitionId": { "type": "string", "format": "uuid", "description": "The functional partition ID associated with this assignment.\n" }, "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition.", "maxLength": 255, "example": "FP1" } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}/financials": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-assignment-financials-by-assignment-id", "summary": "Assignment Financials", "description": "Retrieves current assignment financial information\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "read:assignment" ] } ], "responses": { "200": { "description": "The financial information of an assignment", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "The current state for an assignment's financials.", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "purchaseOrderNumber": { "type": "string", "description": "The purchase order number of the assignment.\n", "maxLength": 25 }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "originalBudget": { "type": "number", "description": "The original budget of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "currentBudget": { "type": "number", "description": "The current budget of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "currentSpend": { "type": "number", "description": "The current Spend of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "remainingBudget": { "type": "number", "description": "The remaining budget of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "timesheetType": { "type": "string", "description": "The timesheet type of the assignment.", "maxLength": 255 }, "bteProjectCodes": { "type": "array", "description": "List of BTE Project Codes", "items": { "type": "string" } }, "currency": { "description": "The currency of the assignment.", "type": "object", "required": [ "currencyId" ], "properties": { "currencyId": { "type": "string", "format": "uuid", "description": "The unique identifier of the currency.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "code": { "type": "string", "description": "The code of the currency.", "maxLength": 3, "example": "USD" } } }, "billRates": { "type": "array", "description": "The bill rates of the assignment.", "items": { "type": "object", "required": [ "rateId" ], "properties": { "rateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill rate.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "earningCodeName": { "type": "string", "description": "The earning code name of the bill rate.", "maxLength": 255, "example": "name123" }, "rate": { "type": "number", "description": "The rate of the bill rate.", "minimum": 0, "maximum": 922337203685477.6 }, "rateTypeName": { "type": "string", "description": "The rate type name of the bill rate.", "maxLength": 255, "example": "name123" } } } }, "billToCostCenter": { "description": "The bill to cost center associated with this assignment.", "type": "object", "required": [ "costCenterNumber" ], "properties": { "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" }, "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The organization unit code of the cost center.", "maxLength": 50, "example": "ou1" } } }, "adminCostCenter": { "description": "The admin cost center associated with this assignment.", "type": "object", "required": [ "costCenterNumber" ], "properties": { "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" }, "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The organization unit code of the cost center.", "maxLength": 50, "example": "ou1" } } }, "costAllocation": { "description": "The cost allocation of the assignment.", "type": "object", "properties": { "costAllocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "units": { "type": "array", "description": "The units of the cost allocation.", "items": { "type": "object", "properties": { "costAllocationUnitId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "share": { "type": "number", "description": "The percentage share of the cost allocation unit.", "example": 0.3867 }, "segments": { "type": "array", "description": "The segments of the cost allocation unit.", "items": { "type": "object", "properties": { "segmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit segment.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "displayName": { "type": "string", "description": "The display name of the cost allocation unit segment.", "maxLength": 255, "example": "name123" }, "code": { "type": "string", "description": "The code of the cost allocation unit segment.", "maxLength": 512, "example": "code123" } } } }, "costAllocationUnitStartDate": { "type": "string", "format": "date", "description": "- The start date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" }, "costAllocationUnitEndDate": { "type": "string", "format": "date", "description": "- The end date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" } } } } } }, "hiringManager": { "description": "The hiring manager of the assignment.", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the user.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "userName": { "type": "string", "description": "The username of the user.", "maxLength": 50, "example": "username123" } } }, "timesheetApprover": { "description": "The timesheet approver of the assignment.", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the user.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "userName": { "type": "string", "description": "The username of the user.", "maxLength": 50, "example": "username123" } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}/amendments": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "amend-assignment", "summary": "Amend Assignment", "description": "Submits a request to amend an assignment\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "write:assignment" ] } ], "requestBody": { "description": "The assignment amendment details", "content": { "application/json": { "schema": { "type": "object", "description": "The amend assignment request details.", "required": [ "amendmentEffectiveDate" ], "properties": { "amendmentEffectiveDate": { "type": "string", "format": "date", "description": "- The effective date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "amendmentEndDate": { "type": "string", "format": "date", "description": "- The end date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "hiringManagerId": { "type": "string", "format": "uuid", "description": "The unique identifier of the hiring manager." }, "timesheetApproverId": { "type": "string", "format": "uuid", "description": "The unique identifier of the timesheet approver." }, "billToCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill to cost center." }, "adminCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the admin cost center." }, "workLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the work location." }, "physicalWorkLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the physical work location." }, "bteProjectCodes": { "description": "Codes of BTE Projects to add or remove during an assignment amendment.", "type": "object", "properties": { "add": { "type": "array", "description": "Codes of BTE Projects to add to an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "123", "456" ] }, "remove": { "type": "array", "description": "Codes of BTE Projects to remove from an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "111", "222" ] } } }, "budget": { "description": "Adjust the budget of a non- resource-tracked assignment.", "type": "object", "properties": { "budgetAdjustment": { "type": "string", "description": "The action to take on the assignment's budget. If no value is supplied, then this will default to \"doNotAdjustBudget\".", "enum": [ "adjustBudgetBasedOnAmendment", "adjustBudgetDecreaseOnly", "doNotAdjustBudget", "manuallyIncreaseBudget" ], "example": "manuallyIncreaseBudget" }, "budgetAdjustmentAmount": { "type": "number", "description": "Amount value budget is adjusted by. This is an optional field only required if budgetAdjustment is \"manuallyIncreaseBudget\" or \"adjustBudgetDecreaseOnly\".", "minimum": 0, "maximum": 922337203685477.6, "example": 1000 } } }, "comment": { "type": "string", "description": "The comment regarding the amendment of the assignment.", "maxLength": 1024 } } } } } }, "responses": { "202": { "description": "Accepted", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "The assignment accepted response details.", "required": [ "processId" ], "properties": { "processId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment amendment process instance." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}/extensions": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "extend-assignment", "summary": "Extend Amend Assignment", "description": "Submits a request to extend an assignment or submits a request to extend and amend an assignment. Use POST Amend Assignment to submit only an amendment.\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "write:assignment" ] } ], "requestBody": { "description": "The assignment extension and amendment details", "content": { "application/json": { "schema": { "type": "object", "description": "The extend and amend assignment request details.", "required": [ "extensionDate" ], "properties": { "extensionDate": { "type": "string", "format": "date", "description": "- The extension date of the assignment.\n- Supported date format is ISO 8601.\n" }, "amendmentEffectiveDate": { "type": "string", "format": "date", "description": "- The effective date of the assignment amendment.\n- Supported date format is ISO 8601.\n- Required when sending a value to amend.\n- Error will result if only extensionDate and amendmentEffectiveDate are sent.\n" }, "hiringManagerId": { "type": "string", "format": "uuid", "description": "The unique identifier of the hiring manager." }, "timesheetApproverId": { "type": "string", "format": "uuid", "description": "The unique identifier of the timesheet approver." }, "billToCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill to cost center." }, "adminCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the admin cost center." }, "workLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the work location." }, "physicalWorkLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the physical work location." }, "bteProjectCodes": { "description": "Codes of BTE Projects to add or remove during an assignment extension with amendment.", "type": "object", "properties": { "add": { "type": "array", "description": "Codes of BTE Projects to add to an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "123", "456" ] }, "remove": { "type": "array", "description": "Codes of BTE Projects to remove from an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "111", "222" ] } } }, "budget": { "description": "Adjust the budget of a non- resource-tracked assignment.", "type": "object", "properties": { "budgetAdjustment": { "type": "string", "description": "The action to take on the assignment's budget. If no value is supplied, then this will default to \"doNotAdjustBudget\".", "enum": [ "adjustBudgetBasedOnAmendment", "adjustBudgetDecreaseOnly", "doNotAdjustBudget", "manuallyIncreaseBudget" ], "example": "manuallyIncreaseBudget" }, "budgetAdjustmentAmount": { "type": "number", "description": "Amount value budget is adjusted by. This is an optional field only required if budgetAdjustment is \"manuallyIncreaseBudget\" or \"adjustBudgetDecreaseOnly\".", "minimum": 0, "maximum": 922337203685477.6, "example": 1000 } } }, "comment": { "type": "string", "description": "The comment regarding the extension of the assignment.", "maxLength": 1024 } } } } } }, "responses": { "202": { "description": "Accepted", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "The assignment accepted response details.", "required": [ "processId" ], "properties": { "processId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment amendment process instance." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/assignments/{assignmentId}/terminations": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "terminate-assignment", "summary": "Terminate Assignment", "description": "Submits a request to terminate an assignment\n", "tags": [ "Assignment" ], "security": [ { "client_auth": [ "write:assignment" ] } ], "requestBody": { "description": "The assignment termination details", "content": { "application/json": { "schema": { "type": "object", "description": "The terminate assignment request details.", "required": [ "terminationDate" ], "properties": { "terminationDate": { "type": "string", "format": "date", "description": "- The termination date of the assignment.\n- Supported date format is ISO 8601.\n" }, "comment": { "type": "string", "description": "The comment regarding the termination of the assignment.", "maxLength": 1024 } } } } } }, "responses": { "202": { "description": "Accepted", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "The assignment accepted response details.", "required": [ "processId" ], "properties": { "processId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment amendment process instance." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/candidates/{candidateId}/client-defined-values": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "candidateId", "description": "Uniquely identifies a candidate.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "get": { "operationId": "get-client-defined-values-by-candidate-id", "summary": "Candidate Client Defined Values List", "description": "Retrieves a list of client-defined values (CDVs) for a specific candidate who has been extended an offer. An empty results set is returned for candidates without an offer.\n", "tags": [ "Candidate" ], "security": [ { "client_auth": [ "read:client-defined" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of client defined values for the given id.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } } } } }, "examples": { "client-defined-value-list": { "value": { "maxItems": 9, "value": [ { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkbox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/candidates/{candidateId}/client-defined-values/{fieldId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "candidateId", "description": "Uniquely identifies a candidate.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "fieldId", "description": "Uniquely identifies an field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-client-defined-value-field-by-candidate-id-and-field-id", "summary": "Candidate Client Defined Field Value", "description": "Retrieves CDF and CDV setup in Enterprise with a given candidate ID and field ID, for only released candidates.\n\nIf there are expected CDV's and none are being returned, please check the state of the candidate via the [Get Candidate Endpoint](#tag/Candidate/operation/get-candidate-by-id).\n", "tags": [ "Candidate" ], "security": [ { "client_auth": [ "read:client-defined" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } }, "examples": { "client-defined-value-string-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" } }, "client-defined-value-text-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" } }, "client-defined-value-int-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 } }, "client-defined-value-money-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 } }, "client-defined-value-date-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" } }, "client-defined-value-checkbox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkBox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true } }, "client-defined-value-single-selector-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } } }, "client-defined-value-dropdown-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } } }, "client-defined-value-shufflebox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/candidates": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-candidate-list", "summary": "Get Candidate List", "description": "Retrieves a list of candidates. Optionally, you can filter by requestId and/or resourceId.\n\n- Omit both requestId and resourceId to retrieve all candidates.\n- Provide requestId to retrieve candidates associated with a specific request.\n- Provide resourceId to retrieve a specific candidate by its resourceId. There could be more than one if the candidate is on multiple requests.\n- Provide both requestId and resourceId to retrieve a specific candidate associated with a specific request. This will return at most one candidate.\n", "tags": [ "Candidate" ], "security": [ { "client_auth": [ "read:candidate" ] } ], "parameters": [ { "in": "query", "name": "requestId", "description": "Uniquely identifies a request.", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "resourceId", "description": "Uniquely identifies a resource.", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of candidates", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of candidates" }, "value": { "type": "array", "description": "An array of candidates. If there are no candidates, this will be an empty array.", "items": { "type": "object", "description": "Current state for a candidate.", "required": [ "candidateId" ], "properties": { "candidateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the candidate.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/candidates/{candidateId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "candidateId", "description": "Uniquely identifies a candidate.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-candidate-by-id", "summary": "Get Candidate", "description": "Retrieves current candidate information\n", "tags": [ "Candidate" ], "security": [ { "client_auth": [ "read:candidate" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Current state for a candidate.", "required": [ "candidateId", "requestId" ], "properties": { "candidateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the candidate.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "requestId": { "type": "string", "format": "uuid", "description": "The unique identifier of the request to which the resource was submitted.", "example": "b898ed43-52d9-42df-9fc3-75f4ee70e3fc" }, "candidate": { "type": "object", "required": [ "resourceId" ], "description": "The details for the candidate.", "properties": { "resourceId": { "type": "string", "format": "uuid", "description": "The unique identifier of the resource submitted to the request.", "example": "f9b45700-c832-4661-bf4a-8ac4cd9c0ba8" }, "beelineUniqueId": { "type": [ "string" ], "description": "- An alternate unique identifier for the candidate\n- Visible within the Beeline VMS\n", "maxLength": 50, "example": "abcd1234" }, "firstName": { "type": [ "string" ], "description": "The first name of the candidate.", "maxLength": 100, "example": "John" }, "middleName": { "type": [ "string" ], "description": "The middle name of the candidate.", "maxLength": 100, "example": "Lee" }, "lastName": { "type": [ "string" ], "description": "The last name of the candidate.", "maxLength": 100, "example": "Smith" }, "secondaryLastName": { "type": [ "string" ], "description": "The secondary last name of the candidate.", "maxLength": 100, "example": "Davis" }, "email": { "type": [ "string" ], "description": "The resource profile email address of the candidate.", "maxLength": 255, "example": "my.email@domain.com" }, "phones": { "type": "array", "description": "A list of worker's resource phones.", "items": { "properties": { "phoneType": { "type": "string", "description": "The phone type.", "enum": [ "business", "fax", "home", "mobile" ] }, "phoneNumber": { "type": "string", "description": "The phone number.", "maxLength": 30, "example": "212-555-1212" } } } } } }, "supplier": { "description": "The associated supplier to this candidate.", "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "type": "string", "format": "uuid", "description": "The unique identifier of the supplier.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "supplierCode": { "type": "string", "description": "The code for this supplier.", "maxLength": 50, "example": "code123" } } }, "formerContractor": { "type": [ "boolean" ], "description": "A flag indicating whether the candidate is a former contractor." }, "formerEmployee": { "type": [ "boolean" ], "description": "A flag indicating whether the candidate is a former employee." }, "candidateConfirmation": { "type": "object", "description": "The confirmation details for the candidate.", "properties": { "scheduledStartDate": { "type": [ "string" ], "format": "date", "description": "- The scheduled start date of the candidate.\n- Supported date format is ISO 8601\n", "example": "2024-01-18" }, "scheduledEndDate": { "type": [ "string" ], "format": "date", "description": "- The scheduled end date of the candidate.\n- Supported date format is ISO 8601\n", "example": "2024-01-18" }, "billToCostCenter": { "description": "The bill to cost center associated with this candidate.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "adminCostCenter": { "description": "The admin cost center associated with this candidate.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "taxLocation": { "description": "The location where taxes are applied.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "physicalWorkLocation": { "description": "The work location for this candidate.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } } } }, "candidateStatus": { "type": "string", "maxLength": 255, "description": "Standard Beeline names: {:@CU.Cand.Stat.InterviewRequired}, {:@CU.Cand.Stat.PendingBackgroundChecks},\n{:@CU.Cand.Stat.PendingConfirmation}, {:@CU.Cand.Stat.MSP.Disqualified}, {:@CU.Cand.Stat.Onboarded},\n{:@CU.Cand.Stat.Offer.Accepted}, {:@CU.Cand.Stat.Submitted}, {:@CU.Cand.Stat.InterviewRejected},\n{:@CU.Cand.Stat.Rejected}, {:@CU.Cand.Stat.PendingOnboarding}, {:@CU.Cand.Stat.QualifiedInterviewActivity},\n{:@CU.Cand.Stat.InterviewActivity}, {:@CU.Cand.Stat.Withdrawn}, {:@CU.Cand.Stat.InterviewCompleted},\n{:@CU.Cand.Stat.InterviewScheduled}, {:@CU.Cand.Stat.Qualified}, {:@CU.Cand.Stat.Cancelled},\n{:@CU.Cand.Stat.Disqualified}, {:@CU.Cand.Stat.OfferRejected}, {:@CU.Cand.Stat.InterviewCancelled},\n{:@CU.Cand.Stat.HMDisqualified}, {:@CU.Cand.Stat.InterviewPending}, {:@CU.Cand.Stat.OfferWithdrawn},\n{:@CU.Cand.Stat.OfferPending}, {:@CU.Cand.Stat.ReadyforOffer}, {:@CU.Cand.Stat.InterviewRequested},\n{:@CU.Cand.Stat.PendingSubmission}, {:@CU.Cand.Stat.PendingOnboardingProcessing},\n{:@CU.Cand.Stat.InterviewPendingMSPApproval}\n\nThe status name of the candidate. This can be a standard Beeline status name or an added custom value.\n" }, "businessArea": { "type": "object", "required": [ "businessAreaId" ], "description": "The business area associated with this candidate.\n", "properties": { "businessAreaId": { "type": "string", "format": "uuid", "description": "The business area ID associated with this candidate.\n" }, "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area.", "maxLength": 255, "example": "BA123" } } }, "functionalPartition": { "type": "object", "required": [ "functionalPartitionId" ], "description": "The functional partition associated with this candidate.\n", "properties": { "functionalPartitionId": { "type": "string", "format": "uuid", "description": "The functional partition ID associated with this candidate.\n" }, "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition.", "maxLength": 255, "example": "FP1" } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/requests/{requestId}/client-defined-values": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "requestId", "description": "Uniquely identifies a request.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "get": { "operationId": "get-client-defined-values-by-request-id", "summary": "Request Client Defined Values List", "description": "Retrieves a list of client-defined values (CDVs) for a specific request.\n", "tags": [ "Request" ], "security": [ { "client_auth": [ "read:client-defined" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of client defined values for the given id.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } } } } }, "examples": { "client-defined-value-list": { "value": { "maxItems": 9, "value": [ { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkbox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } ] } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "patch": { "operationId": "patch-client-defined-values-by-request-id", "summary": "Update Request Client Defined Values", "description": "Updates client-defined values (CDVs) for a specific request.\n", "tags": [ "Request" ], "security": [ { "client_auth": [ "read:request", "write:client-defined" ] } ], "requestBody": { "description": "The request client defined values update details", "content": { "application/json": { "schema": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "clientDefinedValues": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "value": { "description": "Value of the client defined field.\n- If a fieldId is provided and no value, then the value will be cleared.\n- multipleItemValues will overwrite what exists. e.g. providing an empty array will deselect all items.\n- Only CDVs sent in the request body will be updated. Any field not included will retain its value.\n- Update of attachments and single selector is not supported at this time.\n", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "string", "format": "uuid", "title": "dropdown", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, { "type": "array", "title": "shufflebox", "description": "An array of unique identifiers for the items selected in a shufflebox of the client defined field.", "items": { "type": "string", "format": "uuid" } } ] } } }, "description": "Client defined values to be updated." } } }, "examples": { "update-request-cdvs-request": { "value": { "clientDefinedValues": [ { "fieldId": "550e8400-e29b-41d4-a716-446655440000", "value": "some string value" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440001", "value": "some larger text value" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440002", "value": 87366 }, { "fieldId": "550e8400-e29b-41d4-a716-446655440003", "value": "2023-01-18T00:00:00Z" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440004", "value": 100.5 }, { "fieldId": "550e8400-e29b-41d4-a716-446655440005", "value": true }, { "fieldId": "550e8400-e29b-41d4-a716-446655440006", "value": "550e8400-e29b-41d4-a716-446655440006" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440007", "value": [ "550e8400-e29b-41d4-a716-446655440008", "550e8400-e29b-41d4-a716-446655440009" ] } ] } } } } } }, "responses": { "200": { "description": "Request Client Defined Values Updated", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/requests/{requestId}/client-defined-values/{fieldId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "requestId", "description": "Uniquely identifies a request.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "path", "name": "fieldId", "description": "Uniquely identifies an field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-client-defined-value-field-by-request-id-and-field-id", "summary": "Request Client Defined Field Value", "description": "Retrieves CDF and CDV setup in Enterprise with a given request ID and field ID.\n", "tags": [ "Request" ], "security": [ { "client_auth": [ "read:client-defined" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } }, "examples": { "client-defined-value-string-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" } }, "client-defined-value-text-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" } }, "client-defined-value-int-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 } }, "client-defined-value-money-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 } }, "client-defined-value-date-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" } }, "client-defined-value-checkbox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkBox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true } }, "client-defined-value-single-selector-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } } }, "client-defined-value-dropdown-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } } }, "client-defined-value-shufflebox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/requests/{requestId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "in": "path", "name": "requestId", "description": "Uniquely identifies a request.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-request-by-id", "summary": "Get Request", "description": "Retrieves current request information\n", "tags": [ "Request" ], "security": [ { "client_auth": [ "read:request" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Details about a procurement request.", "required": [ "requestId" ], "properties": { "requestId": { "type": "string", "format": "uuid", "description": "The unique identifier of the request.", "example": "af8ab5fa-4286-45a9-9937-404f399014b8" }, "status": { "type": "string", "description": "The status of the request.", "enum": [ "pending", "open", "onHold", "cancelled", "filled", "rejected", "reOpen", "notSubmitted", "correctionRequired" ] }, "requestNumber": { "type": "string", "description": "The unique request number.", "example": "21-1" }, "reasonForRequest": { "type": "string", "description": "The reason for the request." }, "quantity": { "type": "integer", "description": "The amount of openings for the request." }, "procurementType": { "type": "string", "description": "The request procurement type.", "enum": [ "contingent", "permanent", "services", "project" ] }, "requestDate": { "type": "string", "format": "date-time", "description": "The date and time that the request was created. - Supported date format is ISO 8601", "example": "2023-01-18T17:59:51.753Z" }, "estimatedCost": { "description": "The estimated cost for the request.", "type": "object", "properties": { "currency": { "description": "The unique code that identifies the currency for the amount.", "maxLength": 3, "example": "USD" }, "amount": { "description": "The request's estimated cost amount in the currency.", "type": "number", "example": 12345.67 } } }, "estimatedExpense": { "description": "The estimated expense for the request.", "type": "object", "properties": { "currency": { "description": "The unique code that identifies the currency for the amount.", "maxLength": 3, "example": "USD" }, "amount": { "description": "The request's estimated cost amount in the currency.", "type": "number", "example": 12345.67 } } }, "startDate": { "type": "string", "format": "date", "description": "The date when the hiring manager wants the assignment to start. - Supported date format is ISO 8601", "example": "2023-01-18" }, "calculated": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "description": "The calculated assignment end date associated with the request.", "example": "2023-05-04" } } }, "hoursPerWeek": { "type": "number", "description": "The hours per week for the request." }, "jobTitle": { "type": "object", "description": "The job title associated with the request.", "required": [ "jobTitleId" ], "properties": { "jobTitleId": { "type": "string", "format": "uuid", "description": "The unique identifier of the job title.", "example": "bb8ab5f3-4286-45a9-9937-404f399025c9" }, "name": { "type": "string", "description": "The name of the job title." } } }, "hiringManager": { "type": "object", "description": "The hiring manager associated with the request.", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The Beeline user unique identifier of the hiring manager.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "userName": { "type": "string", "description": "The username of the hiring manager." } } }, "billToCostCenter": { "description": "The bill-to cost center associated with the request.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "adminCostCenter": { "description": "The admin cost center associated with the request.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "taxLocation": { "description": "The VMS defined location information for the tax location associated with the request.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "physicalWorkLocation": { "description": "The VMS defined location information for the physical work location associated with the request.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/intake-process/request-forms": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "post": { "operationId": "post-request-intake-form", "summary": "Create Intake Form", "description": "Creates a Request Intake Form.\n", "tags": [ "Request" ], "security": [ { "client_auth": [ "write:intake-form" ] } ], "requestBody": { "description": "Request Intake Form to create", "content": { "application/json": { "schema": { "type": "object", "description": "A Request Intake Form.", "required": [ "trackingNumber" ], "properties": { "trackingNumber": { "type": "string", "description": "A string to identify the Intake Form. This is provided by the client.\n", "maxLength": 255, "example": "IntakeForm123" }, "requestor": { "type": "string", "description": "The requestor of the intake form.\n", "maxLength": 255, "example": "Hanson Deck" }, "hiringManager": { "type": "string", "description": "The Hiring Manager.\n", "maxLength": 255, "example": "Guy Mann" }, "startDate": { "type": "string", "format": "date", "description": "- Desired start date of the Procurement Request.\n- Supported date format is ISO 8601.\n", "example": "2023-03-02" }, "endDate": { "type": "string", "format": "date", "description": "- Desired end date of the Procurement Request.\n- Supported date format is ISO 8601.\n", "example": "2024-03-02" }, "physicalWorkLocation": { "type": "string", "description": "The physical work location.\n", "maxLength": 255, "example": "Decatur, IL" }, "jobTitle": { "type": "string", "description": "The job title.\n", "maxLength": 255, "example": "Sales Manager" }, "requestComments": { "type": "string", "description": "The request comments.\n", "example": "Comments about the request." }, "hasPreIdentifiedCandidate": { "type": "string", "description": "Indicates if there is a pre-identified candidate.\n", "example": "Yes" }, "currency": { "type": "string", "description": "The currency for the budget amount.\n", "example": "USD" }, "budgetAmount": { "type": "number", "format": "float", "description": "The budget amount.\n", "example": 500.55 }, "submittedDate": { "type": "string", "format": "datetime", "description": "- The submitted date of the intake form on the client's system.\n- Supported date/time format is ISO 8601.\n", "example": "2024-01-18T14:30:00Z" }, "cdv": { "type": "string", "description": "The Client defined values.\n", "example": "Client-Defined Values" }, "otherComments": { "type": "string", "description": "Additional comments on the intake form.\n", "example": "Additional comments on the request." } } } } } }, "responses": { "201": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Request Intake Form was created", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestIntakeFormId": { "type": "string", "format": "uuid", "description": "A unique identifier for the Intake Form." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "get": { "operationId": "get-request-intake-forms-by-tracking-number-and-request-id", "summary": "Get Intake Forms By Tracking Number and Request ID", "description": "Retrieves a list of Intake Forms By Tracking Number and/or Request ID.\n", "tags": [ "Request" ], "parameters": [ { "name": "trackingNumber", "in": "query", "description": "The Tracking Number of the Intake Form.", "schema": { "type": "string", "example": "TrackingNumber123" } }, { "name": "requestId", "in": "query", "description": "The Beeline Request ID associated to the Intake form.", "schema": { "type": "string", "format": "uuid" } }, { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } } ], "security": [ { "client_auth": [ "read:intake-form" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of Intake Forms.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of Intake Forms." }, "value": { "type": "array", "description": "An array of Intake Forms. If there are no Intake Forms this will be an empty array.", "items": { "type": "object", "required": [ "requestIntakeFormId", "trackingNumber" ], "properties": { "requestIntakeFormId": { "type": "string", "description": "A unique identifier for the Intake Form generated by Beeline.", "format": "uuid" }, "trackingNumber": { "type": "string", "description": "A string to identify the Intake Form. This is provided by the client.", "maxLength": 255, "example": "IntakeForm123" }, "status": { "type": "string", "enum": [ "open", "inProgress", "completed" ], "description": "- Open represents a Request Intake Form that is open for an MSP to take ownership.\n- InProgress represents a Request Intake Form that an MSP has taken ownership of and possibly being used to create a Procurement Request.\n- Completed represents a Request Intake Form that has been used to successfully create a Procurement Request.\n" }, "request": { "type": "object", "description": "The Beeline Request associated to the Intake Form.", "properties": { "requestId": { "type": "string", "description": "A unique identifier for the Procurement Request.", "format": "uuid" }, "requestNumber": { "type": "string", "description": "A numerical identifier for the Procurement Request.", "example": "1234-1" } } } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/intake-process/request-forms/{intakeFormId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "intakeFormId", "in": "path", "description": "Uniquely identifies an Intake Form.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-request-intake-form-by-intake-form-id", "summary": "Get Intake Form By Intake Form ID", "description": "Retrieves Intake Form By Intake Form ID.\n", "tags": [ "Request" ], "security": [ { "client_auth": [ "read:intake-form" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "requestIntakeFormId", "trackingNumber" ], "properties": { "requestIntakeFormId": { "type": "string", "description": "A unique identifier for the Intake Form generated by Beeline.", "format": "uuid" }, "trackingNumber": { "type": "string", "description": "A string to identify the Intake Form. This is provided by the client.", "maxLength": 255, "example": "IntakeForm123" }, "status": { "type": "string", "enum": [ "open", "inProgress", "completed" ], "description": "- Open represents a Request Intake Form that is open for an MSP to take ownership.\n- InProgress represents a Request Intake Form that an MSP has taken ownership of and possibly being used to create a Procurement Request.\n- Completed represents a Request Intake Form that has been used to successfully create a Procurement Request.\n" }, "request": { "type": "object", "description": "The Beeline Request associated to the Intake Form.", "properties": { "requestId": { "type": "string", "description": "A unique identifier for the Procurement Request.", "format": "uuid" }, "requestNumber": { "type": "string", "description": "A numerical identifier for the Procurement Request.", "example": "1234-1" } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } }, "/sites/{clientSiteId}/workers/{userId}": { "parameters": [ { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, { "name": "userId", "in": "path", "description": "Uniquely identifies a user.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } } ], "get": { "operationId": "get-worker", "summary": "Get Worker", "description": "Retrieves current worker information\n", "tags": [ "Worker" ], "security": [ { "client_auth": [ "read:worker" ] } ], "responses": { "200": { "description": "OK", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "Current state for a worker.", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the worker.", "example": "af8ab5fa-4286-45a9-9937-404f399014b8" }, "beelineUniqueID": { "type": "string", "maxLength": 50, "description": "The Beeline unique identifier of the worker." }, "userName": { "type": "string", "maxLength": 50, "description": "The username of the worker." }, "firstName": { "type": "string", "maxLength": 100, "description": "The first name of the worker." }, "middleName": { "type": "string", "maxLength": 100, "description": "The middle name of the worker." }, "lastName": { "type": "string", "maxLength": 100, "description": "The last name of the worker." }, "localizedFirstName": { "type": "string", "maxLength": 100, "description": "The localized first name of the worker." }, "localizedMiddleName": { "type": "string", "maxLength": 100, "description": "The localized middle name of the worker." }, "localizedLastName": { "type": "string", "maxLength": 100, "description": "The localized last name of the worker." }, "secondaryLastName": { "type": "string", "maxLength": 100, "description": "The secondary last name of the worker." }, "externalID": { "type": "string", "maxLength": 100, "description": "The external id of the worker." }, "email": { "type": "string", "maxLength": 255, "description": "The email of the worker." }, "phones": { "type": "array", "description": "Array of phones of the worker.", "items": { "properties": { "phoneType": { "type": "string", "maxLength": 255, "description": "The phone type of the worker phone.", "enum": [ "mobile", "home", "fax", "business" ] }, "phoneNumber": { "type": "string", "maxLength": 30, "description": "The phone number of the worker phone." } } } } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } }, "put": { "operationId": "update-worker", "summary": "Update Worker", "description": "Updates current worker information.\n", "tags": [ "Worker" ], "security": [ { "client_auth": [ "write:worker" ] } ], "requestBody": { "description": "Update an existing worker user in the VMS", "content": { "application/json": { "schema": { "description": "A worker.", "required": [ "userName", "email" ], "properties": { "userName": { "type": "string", "maxLength": 50, "description": "The username of the worker." }, "externalID": { "type": "string", "maxLength": 100, "description": "The external id of the worker." }, "email": { "type": "string", "maxLength": 255, "description": "The email of the worker." } } } } } }, "responses": { "200": { "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "description": "Worker was updated", "content": { "application/json": { "schema": { "type": "object", "description": "A worker.", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the worker.", "example": "af8ab5fa-4286-45a9-9937-404f399014b8" }, "userName": { "type": "string", "maxLength": 50, "description": "The username of the worker." }, "externalID": { "type": "string", "maxLength": 100, "description": "The external id of the worker." }, "email": { "type": "string", "maxLength": 255, "description": "The email of the worker." } } } } } }, "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "409": { "description": "Conflict", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } } } } } }, "components": { "parameters": { "client-site-id": { "in": "path", "name": "clientSiteId", "description": "Uniquely identifies a Beeline VMS instance.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "abc78252-1d8d-4ecf-9651-6b5ba39bba5b" }, "field-id": { "in": "path", "name": "fieldId", "description": "Uniquely identifies an field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "assignment-id": { "in": "path", "name": "assignmentId", "description": "Uniquely identifies an assignment.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "assignment-user-id": { "name": "userId", "in": "query", "description": "Uniquely identifies a user.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "assignment-number": { "in": "path", "name": "assignmentNumber", "description": "The assignment number that uniquely identifies an assignment", "required": true, "schema": { "type": "integer" }, "example": 1 }, "assignment-status": { "name": "statusType", "in": "query", "description": "Uniquely identifies an assignment status.", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "active", "cancel", "expired", "pending", "rejected", "scheduled", "void" ] } } }, "candidate-id": { "in": "path", "name": "candidateId", "description": "Uniquely identifies a candidate.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "candidate-request-id": { "in": "query", "name": "requestId", "description": "Uniquely identifies a request.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "candidate-resource-id": { "in": "query", "name": "resourceId", "description": "Uniquely identifies a resource.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "request-id": { "in": "path", "name": "requestId", "description": "Uniquely identifies a request.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "user-id": { "name": "userId", "in": "path", "description": "Uniquely identifies a user.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "intake-form-id": { "name": "intakeFormId", "in": "path", "description": "Uniquely identifies an Intake Form.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "request-id-query": { "name": "requestId", "in": "query", "description": "The Beeline Request ID associated to the Intake form.", "schema": { "type": "string", "format": "uuid" } }, "tracking-number": { "name": "trackingNumber", "in": "query", "description": "The Tracking Number of the Intake Form.", "schema": { "type": "string", "example": "TrackingNumber123" } }, "api-version": { "name": "api-version", "in": "query", "description": "The API version of the endpoint", "required": true, "schema": { "type": "string", "enum": [ "2023-07-01" ] } }, "skip": { "name": "skip", "in": "query", "description": "skip a number of records", "required": false, "schema": { "type": "integer", "minimum": 0 } }, "top": { "name": "top", "in": "query", "description": "select up to 1000 records", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, "intake-form-request-id": { "name": "requestId", "in": "query", "description": "The Beeline Request ID associated to the Intake form.", "schema": { "type": "string", "format": "uuid" } } }, "headers": { "rate-limit-limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "rate-limit-remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "rate-limit-reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } }, "retry-after": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "responses": { "400": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "401": { "description": "Unauthorized", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "403": { "description": "Forbidden", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } } }, "404": { "description": "Not Found", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, { "type": "null" } ] } } } }, "409": { "description": "Conflict", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "429": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "The number of seconds remaining when the endpoint can be called again.", "schema": { "type": "integer" }, "example": 10 } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "examples": { "rate-limit": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } } } } } }, "500": { "description": "Internal Server error", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } } } } }, "400-inner": { "description": "Bad Request", "headers": { "X-Rate-Limit-Limit": { "description": "The rate limit period (eg. 1m, 12h, 1d)", "schema": { "type": "string" }, "example": "8h" }, "X-Rate-Limit-Remaining": { "description": "The number of calls remaining in the time window", "schema": { "type": "integer" }, "example": 10 }, "X-Rate-Limit-Reset": { "description": "UTC date time (ISO 8601) when the limit resets", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object", "description": "An Error Response.", "required": [ "error" ], "properties": { "error": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } } } } } } } }, "schemas": { "client-defined-value": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } }, "client-defined-value-list": { "type": "object", "description": "A list of client defined values for the given id.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } } } } }, "assignment-model": { "type": "object", "description": "Current state for an assignment.", "required": [ "assignmentId", "assignmentDetailId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "assignmentDetailId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment detail.\n", "example": "7a40445f-7b8f-4cef-aa10-72f6cb889eb1" }, "assignmentNumber": { "type": "integer", "description": "The number of the assignment.\n", "example": 34593745 }, "procurementType": { "type": "string", "enum": [ "contingent", "permanent", "project", "services" ], "description": "The procurement type of the assignment.\n", "example": "Contingent" }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "jobTitle": { "type": "object", "required": [ "jobTitleId" ], "description": "The job title associated with this assignment.\n", "properties": { "jobTitleId": { "type": "string", "format": "uuid", "description": "The unique identifier of the job title.\n" }, "jobTitleName": { "type": "string", "description": "The name of the job title.\n" } } }, "hiringManager": { "type": "object", "description": "The hiring manager associated with this assignment.\n", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the hiring manager.\n" }, "userName": { "type": "string", "description": "The username of the hiring manager.\n" } } }, "billToCostCenter": { "description": "The bill to cost center associated with this assignment.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "adminCostCenter": { "description": "The admin cost center associated with this assignment.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "taxLocation": { "description": "The location where taxes are applied.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "physicalWorkLocation": { "description": "The work location for this assignment.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "worker": { "type": "object", "description": "The specific worker for this assignment.\n", "required": [ "userId", "resourceId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the worker.\n" }, "resourceId": { "type": "string", "format": "uuid", "description": "The worker's resource unique identifier.\n" }, "userName": { "type": "string", "description": "The userName of this worker.\n" } } }, "supplier": { "description": "The associated supplier to this assigment.", "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "type": "string", "format": "uuid", "description": "The unique identifier of the supplier.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "supplierCode": { "type": "string", "description": "The code for this supplier.", "maxLength": 50, "example": "code123" } } }, "statusType": { "type": "string", "enum": [ "expired", "active", "scheduled", "cancel", "void", "pending", "rejected" ], "description": "The status of this assignment.\n" }, "substatus": { "type": "string", "maxLength": 255, "description": "Standard Beeline names: {:@CUAssignmentSubStatusCancelled}, {:@CUAssignmentSubStatusNoShow},\n{:@CUAssignmentSubStatusExtensionProgress}, {:@CUAssignmentSubStatusCancellationProgress},\n{:@CUAssignmentSubStatusReopened}, {:@CUAssignmentSubStatusAmendmentProgress},\n{:@CUAssignmentSubStatusNA}, {:@CUAssignmentSubStatusTerminationProgress}\n\nThe substatus name of the assignment. This can be a standard Beeline substatus name\nor an added customer value.\n" }, "requestorUserId": { "type": "string", "format": "uuid", "description": "The unique identifier of the requestor." }, "sponsorUserId": { "type": "string", "format": "uuid", "description": "The unique identifier of the sponsor." }, "requestId": { "type": "string", "format": "uuid", "description": "The unique identifier of the request." }, "businessArea": { "type": "object", "required": [ "businessAreaId" ], "description": "The business area associated with this assignment.\n", "properties": { "businessAreaId": { "type": "string", "format": "uuid", "description": "The business area ID associated with this assignment.\n" }, "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area.", "maxLength": 255, "example": "BA123" } } }, "functionalPartition": { "type": "object", "required": [ "functionalPartitionId" ], "description": "The functional partition associated with this assignment.\n", "properties": { "functionalPartitionId": { "type": "string", "format": "uuid", "description": "The functional partition ID associated with this assignment.\n" }, "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition.", "maxLength": 255, "example": "FP1" } } } } }, "assignment-id": { "type": "object", "description": "An assignment Id", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" } } }, "assignment-array": { "type": "object", "description": "A list of assignments", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of assignments" }, "value": { "type": "array", "description": "An array of assignments. If there are no assignments, this will be an empty array.", "items": { "type": "object", "description": "Current state for an assignment.", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "statusType": { "type": "string", "enum": [ "active", "cancel", "expired", "pending", "rejected", "scheduled", "void" ], "description": "The status of this assignment.\n" } } } } } }, "amend-assignment-cdvs-request": { "type": "object", "description": "The amend assignment request details.", "required": [ "amendmentEffectiveDate" ], "properties": { "amendmentEffectiveDate": { "type": "string", "format": "date", "description": "- The effective date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "amendmentEndDate": { "type": "string", "format": "date", "description": "- The end date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "clientDefinedValues": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "value": { "description": "Value of the client defined field.\n- If a fieldId is provided and no value, then the value will be cleared.\n- multipleItemValues will overwrite what exists. e.g. providing an empty array will deselect all items.\n- Only CDVs sent in the request body will be updated. Any field not included will retain its value.\n- Update of attachments and single selector is not supported at this time.\n", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "string", "format": "uuid", "title": "dropdown", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, { "type": "array", "title": "shufflebox", "description": "An array of unique identifiers for the items selected in a shufflebox of the client defined field.", "items": { "type": "string", "format": "uuid" } } ] } } }, "description": "Client defined values to be updated." }, "comment": { "type": "string", "description": "The comment regarding the amendment of the assignment.", "maxLength": 1024 } } }, "amend-assignment-request": { "type": "object", "description": "The amend assignment request details.", "required": [ "amendmentEffectiveDate" ], "properties": { "amendmentEffectiveDate": { "type": "string", "format": "date", "description": "- The effective date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "amendmentEndDate": { "type": "string", "format": "date", "description": "- The end date of the assignment amendment.\n- Supported date format is ISO 8601.\n" }, "hiringManagerId": { "type": "string", "format": "uuid", "description": "The unique identifier of the hiring manager." }, "timesheetApproverId": { "type": "string", "format": "uuid", "description": "The unique identifier of the timesheet approver." }, "billToCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill to cost center." }, "adminCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the admin cost center." }, "workLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the work location." }, "physicalWorkLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the physical work location." }, "bteProjectCodes": { "description": "Codes of BTE Projects to add or remove during an assignment amendment.", "type": "object", "properties": { "add": { "type": "array", "description": "Codes of BTE Projects to add to an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "123", "456" ] }, "remove": { "type": "array", "description": "Codes of BTE Projects to remove from an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "111", "222" ] } } }, "budget": { "description": "Adjust the budget of a non- resource-tracked assignment.", "type": "object", "properties": { "budgetAdjustment": { "type": "string", "description": "The action to take on the assignment's budget. If no value is supplied, then this will default to \"doNotAdjustBudget\".", "enum": [ "adjustBudgetBasedOnAmendment", "adjustBudgetDecreaseOnly", "doNotAdjustBudget", "manuallyIncreaseBudget" ], "example": "manuallyIncreaseBudget" }, "budgetAdjustmentAmount": { "type": "number", "description": "Amount value budget is adjusted by. This is an optional field only required if budgetAdjustment is \"manuallyIncreaseBudget\" or \"adjustBudgetDecreaseOnly\".", "minimum": 0, "maximum": 922337203685477.6, "example": 1000 } } }, "comment": { "type": "string", "description": "The comment regarding the amendment of the assignment.", "maxLength": 1024 } } }, "assignment-accepted-response": { "type": "object", "description": "The assignment accepted response details.", "required": [ "processId" ], "properties": { "processId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment amendment process instance." } } }, "assignment-financials-model": { "type": "object", "description": "The current state for an assignment's financials.", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "purchaseOrderNumber": { "type": "string", "description": "The purchase order number of the assignment.\n", "maxLength": 25 }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "originalBudget": { "type": "number", "description": "The original budget of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "currentBudget": { "type": "number", "description": "The current budget of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "currentSpend": { "type": "number", "description": "The current Spend of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "remainingBudget": { "type": "number", "description": "The remaining budget of the assignment", "minimum": 0, "maximum": 922337203685477.6 }, "timesheetType": { "type": "string", "description": "The timesheet type of the assignment.", "maxLength": 255 }, "bteProjectCodes": { "type": "array", "description": "List of BTE Project Codes", "items": { "type": "string" } }, "currency": { "description": "The currency of the assignment.", "type": "object", "required": [ "currencyId" ], "properties": { "currencyId": { "type": "string", "format": "uuid", "description": "The unique identifier of the currency.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "code": { "type": "string", "description": "The code of the currency.", "maxLength": 3, "example": "USD" } } }, "billRates": { "type": "array", "description": "The bill rates of the assignment.", "items": { "type": "object", "required": [ "rateId" ], "properties": { "rateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill rate.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "earningCodeName": { "type": "string", "description": "The earning code name of the bill rate.", "maxLength": 255, "example": "name123" }, "rate": { "type": "number", "description": "The rate of the bill rate.", "minimum": 0, "maximum": 922337203685477.6 }, "rateTypeName": { "type": "string", "description": "The rate type name of the bill rate.", "maxLength": 255, "example": "name123" } } } }, "billToCostCenter": { "description": "The bill to cost center associated with this assignment.", "type": "object", "required": [ "costCenterNumber" ], "properties": { "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" }, "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The organization unit code of the cost center.", "maxLength": 50, "example": "ou1" } } }, "adminCostCenter": { "description": "The admin cost center associated with this assignment.", "type": "object", "required": [ "costCenterNumber" ], "properties": { "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" }, "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The organization unit code of the cost center.", "maxLength": 50, "example": "ou1" } } }, "costAllocation": { "description": "The cost allocation of the assignment.", "type": "object", "properties": { "costAllocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "units": { "type": "array", "description": "The units of the cost allocation.", "items": { "type": "object", "properties": { "costAllocationUnitId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "share": { "type": "number", "description": "The percentage share of the cost allocation unit.", "example": 0.3867 }, "segments": { "type": "array", "description": "The segments of the cost allocation unit.", "items": { "type": "object", "properties": { "segmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit segment.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "displayName": { "type": "string", "description": "The display name of the cost allocation unit segment.", "maxLength": 255, "example": "name123" }, "code": { "type": "string", "description": "The code of the cost allocation unit segment.", "maxLength": 512, "example": "code123" } } } }, "costAllocationUnitStartDate": { "type": "string", "format": "date", "description": "- The start date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" }, "costAllocationUnitEndDate": { "type": "string", "format": "date", "description": "- The end date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" } } } } } }, "hiringManager": { "description": "The hiring manager of the assignment.", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the user.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "userName": { "type": "string", "description": "The username of the user.", "maxLength": 50, "example": "username123" } } }, "timesheetApprover": { "description": "The timesheet approver of the assignment.", "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the user.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "userName": { "type": "string", "description": "The username of the user.", "maxLength": 50, "example": "username123" } } } } }, "terminate-assignment-request": { "type": "object", "description": "The terminate assignment request details.", "required": [ "terminationDate" ], "properties": { "terminationDate": { "type": "string", "format": "date", "description": "- The termination date of the assignment.\n- Supported date format is ISO 8601.\n" }, "comment": { "type": "string", "description": "The comment regarding the termination of the assignment.", "maxLength": 1024 } } }, "extend-assignment-request": { "type": "object", "description": "The extend and amend assignment request details.", "required": [ "extensionDate" ], "properties": { "extensionDate": { "type": "string", "format": "date", "description": "- The extension date of the assignment.\n- Supported date format is ISO 8601.\n" }, "amendmentEffectiveDate": { "type": "string", "format": "date", "description": "- The effective date of the assignment amendment.\n- Supported date format is ISO 8601.\n- Required when sending a value to amend.\n- Error will result if only extensionDate and amendmentEffectiveDate are sent.\n" }, "hiringManagerId": { "type": "string", "format": "uuid", "description": "The unique identifier of the hiring manager." }, "timesheetApproverId": { "type": "string", "format": "uuid", "description": "The unique identifier of the timesheet approver." }, "billToCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill to cost center." }, "adminCostCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the admin cost center." }, "workLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the work location." }, "physicalWorkLocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the physical work location." }, "bteProjectCodes": { "description": "Codes of BTE Projects to add or remove during an assignment extension with amendment.", "type": "object", "properties": { "add": { "type": "array", "description": "Codes of BTE Projects to add to an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "123", "456" ] }, "remove": { "type": "array", "description": "Codes of BTE Projects to remove from an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "111", "222" ] } } }, "budget": { "description": "Adjust the budget of a non- resource-tracked assignment.", "type": "object", "properties": { "budgetAdjustment": { "type": "string", "description": "The action to take on the assignment's budget. If no value is supplied, then this will default to \"doNotAdjustBudget\".", "enum": [ "adjustBudgetBasedOnAmendment", "adjustBudgetDecreaseOnly", "doNotAdjustBudget", "manuallyIncreaseBudget" ], "example": "manuallyIncreaseBudget" }, "budgetAdjustmentAmount": { "type": "number", "description": "Amount value budget is adjusted by. This is an optional field only required if budgetAdjustment is \"manuallyIncreaseBudget\" or \"adjustBudgetDecreaseOnly\".", "minimum": 0, "maximum": 922337203685477.6, "example": 1000 } } }, "comment": { "type": "string", "description": "The comment regarding the extension of the assignment.", "maxLength": 1024 } } }, "candidate-model": { "type": "object", "description": "Current state for a candidate.", "required": [ "candidateId", "requestId" ], "properties": { "candidateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the candidate.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "requestId": { "type": "string", "format": "uuid", "description": "The unique identifier of the request to which the resource was submitted.", "example": "b898ed43-52d9-42df-9fc3-75f4ee70e3fc" }, "candidate": { "type": "object", "required": [ "resourceId" ], "description": "The details for the candidate.", "properties": { "resourceId": { "type": "string", "format": "uuid", "description": "The unique identifier of the resource submitted to the request.", "example": "f9b45700-c832-4661-bf4a-8ac4cd9c0ba8" }, "beelineUniqueId": { "type": [ "string" ], "description": "- An alternate unique identifier for the candidate\n- Visible within the Beeline VMS\n", "maxLength": 50, "example": "abcd1234" }, "firstName": { "type": [ "string" ], "description": "The first name of the candidate.", "maxLength": 100, "example": "John" }, "middleName": { "type": [ "string" ], "description": "The middle name of the candidate.", "maxLength": 100, "example": "Lee" }, "lastName": { "type": [ "string" ], "description": "The last name of the candidate.", "maxLength": 100, "example": "Smith" }, "secondaryLastName": { "type": [ "string" ], "description": "The secondary last name of the candidate.", "maxLength": 100, "example": "Davis" }, "email": { "type": [ "string" ], "description": "The resource profile email address of the candidate.", "maxLength": 255, "example": "my.email@domain.com" }, "phones": { "type": "array", "description": "A list of worker's resource phones.", "items": { "properties": { "phoneType": { "type": "string", "description": "The phone type.", "enum": [ "business", "fax", "home", "mobile" ] }, "phoneNumber": { "type": "string", "description": "The phone number.", "maxLength": 30, "example": "212-555-1212" } } } } } }, "supplier": { "description": "The associated supplier to this candidate.", "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "type": "string", "format": "uuid", "description": "The unique identifier of the supplier.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "supplierCode": { "type": "string", "description": "The code for this supplier.", "maxLength": 50, "example": "code123" } } }, "formerContractor": { "type": [ "boolean" ], "description": "A flag indicating whether the candidate is a former contractor." }, "formerEmployee": { "type": [ "boolean" ], "description": "A flag indicating whether the candidate is a former employee." }, "candidateConfirmation": { "type": "object", "description": "The confirmation details for the candidate.", "properties": { "scheduledStartDate": { "type": [ "string" ], "format": "date", "description": "- The scheduled start date of the candidate.\n- Supported date format is ISO 8601\n", "example": "2024-01-18" }, "scheduledEndDate": { "type": [ "string" ], "format": "date", "description": "- The scheduled end date of the candidate.\n- Supported date format is ISO 8601\n", "example": "2024-01-18" }, "billToCostCenter": { "description": "The bill to cost center associated with this candidate.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "adminCostCenter": { "description": "The admin cost center associated with this candidate.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "taxLocation": { "description": "The location where taxes are applied.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "physicalWorkLocation": { "description": "The work location for this candidate.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } } } }, "candidateStatus": { "type": "string", "maxLength": 255, "description": "Standard Beeline names: {:@CU.Cand.Stat.InterviewRequired}, {:@CU.Cand.Stat.PendingBackgroundChecks},\n{:@CU.Cand.Stat.PendingConfirmation}, {:@CU.Cand.Stat.MSP.Disqualified}, {:@CU.Cand.Stat.Onboarded},\n{:@CU.Cand.Stat.Offer.Accepted}, {:@CU.Cand.Stat.Submitted}, {:@CU.Cand.Stat.InterviewRejected},\n{:@CU.Cand.Stat.Rejected}, {:@CU.Cand.Stat.PendingOnboarding}, {:@CU.Cand.Stat.QualifiedInterviewActivity},\n{:@CU.Cand.Stat.InterviewActivity}, {:@CU.Cand.Stat.Withdrawn}, {:@CU.Cand.Stat.InterviewCompleted},\n{:@CU.Cand.Stat.InterviewScheduled}, {:@CU.Cand.Stat.Qualified}, {:@CU.Cand.Stat.Cancelled},\n{:@CU.Cand.Stat.Disqualified}, {:@CU.Cand.Stat.OfferRejected}, {:@CU.Cand.Stat.InterviewCancelled},\n{:@CU.Cand.Stat.HMDisqualified}, {:@CU.Cand.Stat.InterviewPending}, {:@CU.Cand.Stat.OfferWithdrawn},\n{:@CU.Cand.Stat.OfferPending}, {:@CU.Cand.Stat.ReadyforOffer}, {:@CU.Cand.Stat.InterviewRequested},\n{:@CU.Cand.Stat.PendingSubmission}, {:@CU.Cand.Stat.PendingOnboardingProcessing},\n{:@CU.Cand.Stat.InterviewPendingMSPApproval}\n\nThe status name of the candidate. This can be a standard Beeline status name or an added custom value.\n" }, "businessArea": { "type": "object", "required": [ "businessAreaId" ], "description": "The business area associated with this candidate.\n", "properties": { "businessAreaId": { "type": "string", "format": "uuid", "description": "The business area ID associated with this candidate.\n" }, "businessAreaCode": { "type": "string", "description": "A code uniquely identifying the business area.", "maxLength": 255, "example": "BA123" } } }, "functionalPartition": { "type": "object", "required": [ "functionalPartitionId" ], "description": "The functional partition associated with this candidate.\n", "properties": { "functionalPartitionId": { "type": "string", "format": "uuid", "description": "The functional partition ID associated with this candidate.\n" }, "functionalPartitionCode": { "type": "string", "description": "A code uniquely identifying the functional partition.", "maxLength": 255, "example": "FP1" } } } } }, "candidate-id-array": { "type": "object", "description": "A list of candidates", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of candidates" }, "value": { "type": "array", "description": "An array of candidates. If there are no candidates, this will be an empty array.", "items": { "type": "object", "description": "Current state for a candidate.", "required": [ "candidateId" ], "properties": { "candidateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the candidate.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" } } } } } }, "request-model": { "type": "object", "description": "Details about a procurement request.", "required": [ "requestId" ], "properties": { "requestId": { "type": "string", "format": "uuid", "description": "The unique identifier of the request.", "example": "af8ab5fa-4286-45a9-9937-404f399014b8" }, "status": { "type": "string", "description": "The status of the request.", "enum": [ "pending", "open", "onHold", "cancelled", "filled", "rejected", "reOpen", "notSubmitted", "correctionRequired" ] }, "requestNumber": { "type": "string", "description": "The unique request number.", "example": "21-1" }, "reasonForRequest": { "type": "string", "description": "The reason for the request." }, "quantity": { "type": "integer", "description": "The amount of openings for the request." }, "procurementType": { "type": "string", "description": "The request procurement type.", "enum": [ "contingent", "permanent", "services", "project" ] }, "requestDate": { "type": "string", "format": "date-time", "description": "The date and time that the request was created. - Supported date format is ISO 8601", "example": "2023-01-18T17:59:51.753Z" }, "estimatedCost": { "description": "The estimated cost for the request.", "type": "object", "properties": { "currency": { "description": "The unique code that identifies the currency for the amount.", "maxLength": 3, "example": "USD" }, "amount": { "description": "The request's estimated cost amount in the currency.", "type": "number", "example": 12345.67 } } }, "estimatedExpense": { "description": "The estimated expense for the request.", "type": "object", "properties": { "currency": { "description": "The unique code that identifies the currency for the amount.", "maxLength": 3, "example": "USD" }, "amount": { "description": "The request's estimated cost amount in the currency.", "type": "number", "example": 12345.67 } } }, "startDate": { "type": "string", "format": "date", "description": "The date when the hiring manager wants the assignment to start. - Supported date format is ISO 8601", "example": "2023-01-18" }, "calculated": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date", "description": "The calculated assignment end date associated with the request.", "example": "2023-05-04" } } }, "hoursPerWeek": { "type": "number", "description": "The hours per week for the request." }, "jobTitle": { "type": "object", "description": "The job title associated with the request.", "required": [ "jobTitleId" ], "properties": { "jobTitleId": { "type": "string", "format": "uuid", "description": "The unique identifier of the job title.", "example": "bb8ab5f3-4286-45a9-9937-404f399025c9" }, "name": { "type": "string", "description": "The name of the job title." } } }, "hiringManager": { "type": "object", "description": "The hiring manager associated with the request.", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The Beeline user unique identifier of the hiring manager.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "userName": { "type": "string", "description": "The username of the hiring manager." } } }, "billToCostCenter": { "description": "The bill-to cost center associated with the request.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "adminCostCenter": { "description": "The admin cost center associated with the request.", "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "taxLocation": { "description": "The VMS defined location information for the tax location associated with the request.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "physicalWorkLocation": { "description": "The VMS defined location information for the physical work location associated with the request.", "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } } } }, "update-request-cdvs-request": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "clientDefinedValues": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "value": { "description": "Value of the client defined field.\n- If a fieldId is provided and no value, then the value will be cleared.\n- multipleItemValues will overwrite what exists. e.g. providing an empty array will deselect all items.\n- Only CDVs sent in the request body will be updated. Any field not included will retain its value.\n- Update of attachments and single selector is not supported at this time.\n", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "string", "format": "uuid", "title": "dropdown", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, { "type": "array", "title": "shufflebox", "description": "An array of unique identifiers for the items selected in a shufflebox of the client defined field.", "items": { "type": "string", "format": "uuid" } } ] } } }, "description": "Client defined values to be updated." } } }, "worker-model": { "type": "object", "description": "Current state for a worker.", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the worker.", "example": "af8ab5fa-4286-45a9-9937-404f399014b8" }, "beelineUniqueID": { "type": "string", "maxLength": 50, "description": "The Beeline unique identifier of the worker." }, "userName": { "type": "string", "maxLength": 50, "description": "The username of the worker." }, "firstName": { "type": "string", "maxLength": 100, "description": "The first name of the worker." }, "middleName": { "type": "string", "maxLength": 100, "description": "The middle name of the worker." }, "lastName": { "type": "string", "maxLength": 100, "description": "The last name of the worker." }, "localizedFirstName": { "type": "string", "maxLength": 100, "description": "The localized first name of the worker." }, "localizedMiddleName": { "type": "string", "maxLength": 100, "description": "The localized middle name of the worker." }, "localizedLastName": { "type": "string", "maxLength": 100, "description": "The localized last name of the worker." }, "secondaryLastName": { "type": "string", "maxLength": 100, "description": "The secondary last name of the worker." }, "externalID": { "type": "string", "maxLength": 100, "description": "The external id of the worker." }, "email": { "type": "string", "maxLength": 255, "description": "The email of the worker." }, "phones": { "type": "array", "description": "Array of phones of the worker.", "items": { "properties": { "phoneType": { "type": "string", "maxLength": 255, "description": "The phone type of the worker phone.", "enum": [ "mobile", "home", "fax", "business" ] }, "phoneNumber": { "type": "string", "maxLength": 30, "description": "The phone number of the worker phone." } } } } } }, "update-worker-request": { "description": "A worker.", "required": [ "userName", "email" ], "properties": { "userName": { "type": "string", "maxLength": 50, "description": "The username of the worker." }, "externalID": { "type": "string", "maxLength": 100, "description": "The external id of the worker." }, "email": { "type": "string", "maxLength": 255, "description": "The email of the worker." } } }, "update-worker-response": { "type": "object", "description": "A worker.", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the worker.", "example": "af8ab5fa-4286-45a9-9937-404f399014b8" }, "userName": { "type": "string", "maxLength": 50, "description": "The username of the worker." }, "externalID": { "type": "string", "maxLength": 100, "description": "The external id of the worker." }, "email": { "type": "string", "maxLength": 255, "description": "The email of the worker." } } }, "intake-form-array": { "type": "object", "description": "A list of Intake Forms.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer", "description": "The total number of Intake Forms." }, "value": { "type": "array", "description": "An array of Intake Forms. If there are no Intake Forms this will be an empty array.", "items": { "type": "object", "required": [ "requestIntakeFormId", "trackingNumber" ], "properties": { "requestIntakeFormId": { "type": "string", "description": "A unique identifier for the Intake Form generated by Beeline.", "format": "uuid" }, "trackingNumber": { "type": "string", "description": "A string to identify the Intake Form. This is provided by the client.", "maxLength": 255, "example": "IntakeForm123" }, "status": { "type": "string", "enum": [ "open", "inProgress", "completed" ], "description": "- Open represents a Request Intake Form that is open for an MSP to take ownership.\n- InProgress represents a Request Intake Form that an MSP has taken ownership of and possibly being used to create a Procurement Request.\n- Completed represents a Request Intake Form that has been used to successfully create a Procurement Request.\n" }, "request": { "type": "object", "description": "The Beeline Request associated to the Intake Form.", "properties": { "requestId": { "type": "string", "description": "A unique identifier for the Procurement Request.", "format": "uuid" }, "requestNumber": { "type": "string", "description": "A numerical identifier for the Procurement Request.", "example": "1234-1" } } } } } } } }, "intake-form-create-model": { "type": "object", "description": "A Request Intake Form.", "required": [ "trackingNumber" ], "properties": { "trackingNumber": { "type": "string", "description": "A string to identify the Intake Form. This is provided by the client.\n", "maxLength": 255, "example": "IntakeForm123" }, "requestor": { "type": "string", "description": "The requestor of the intake form.\n", "maxLength": 255, "example": "Hanson Deck" }, "hiringManager": { "type": "string", "description": "The Hiring Manager.\n", "maxLength": 255, "example": "Guy Mann" }, "startDate": { "type": "string", "format": "date", "description": "- Desired start date of the Procurement Request.\n- Supported date format is ISO 8601.\n", "example": "2023-03-02" }, "endDate": { "type": "string", "format": "date", "description": "- Desired end date of the Procurement Request.\n- Supported date format is ISO 8601.\n", "example": "2024-03-02" }, "physicalWorkLocation": { "type": "string", "description": "The physical work location.\n", "maxLength": 255, "example": "Decatur, IL" }, "jobTitle": { "type": "string", "description": "The job title.\n", "maxLength": 255, "example": "Sales Manager" }, "requestComments": { "type": "string", "description": "The request comments.\n", "example": "Comments about the request." }, "hasPreIdentifiedCandidate": { "type": "string", "description": "Indicates if there is a pre-identified candidate.\n", "example": "Yes" }, "currency": { "type": "string", "description": "The currency for the budget amount.\n", "example": "USD" }, "budgetAmount": { "type": "number", "format": "float", "description": "The budget amount.\n", "example": 500.55 }, "submittedDate": { "type": "string", "format": "datetime", "description": "- The submitted date of the intake form on the client's system.\n- Supported date/time format is ISO 8601.\n", "example": "2024-01-18T14:30:00Z" }, "cdv": { "type": "string", "description": "The Client defined values.\n", "example": "Client-Defined Values" }, "otherComments": { "type": "string", "description": "Additional comments on the intake form.\n", "example": "Additional comments on the request." } } }, "intake-form-model": { "type": "object", "required": [ "requestIntakeFormId", "trackingNumber" ], "properties": { "requestIntakeFormId": { "type": "string", "description": "A unique identifier for the Intake Form generated by Beeline.", "format": "uuid" }, "trackingNumber": { "type": "string", "description": "A string to identify the Intake Form. This is provided by the client.", "maxLength": 255, "example": "IntakeForm123" }, "status": { "type": "string", "enum": [ "open", "inProgress", "completed" ], "description": "- Open represents a Request Intake Form that is open for an MSP to take ownership.\n- InProgress represents a Request Intake Form that an MSP has taken ownership of and possibly being used to create a Procurement Request.\n- Completed represents a Request Intake Form that has been used to successfully create a Procurement Request.\n" }, "request": { "type": "object", "description": "The Beeline Request associated to the Intake Form.", "properties": { "requestId": { "type": "string", "description": "A unique identifier for the Procurement Request.", "format": "uuid" }, "requestNumber": { "type": "string", "description": "A numerical identifier for the Procurement Request.", "example": "1234-1" } } } } }, "value-response-string-model": { "type": "string", "title": "string", "description": "The string value of the client defined field." }, "value-response-text-model": { "type": "string", "title": "text", "description": "The text value of the client defined field." }, "value-response-int-model": { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, "value-response-money-model": { "type": "number", "title": "money", "description": "The money value of the client defined field." }, "value-response-date-model": { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, "value-response-checkbox-model": { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, "value-response-single-selector-model": { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, "value-response-dropdown-model": { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, "multiple-item-value-model": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } }, "value-response-shufflebox-model": { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } }, "value-response-model": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } }, "error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } }, "error-response": { "type": "object", "description": "A list of errors.", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "enum": [ "UNEXPECTED_ERROR", "VALIDATION_ERROR", "NOT_FOUND", "REQUEST_LIMIT_EXCEEDED", "UNSUPPORTED_API_VERSION", "CONFLICT" ], "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "The human-readable representation of the error." }, "target": { "type": [ "string", "null" ] } } } } } }, "empty-response": { "type": "null" }, "value-request-dropdown-model": { "type": "string", "format": "uuid", "title": "dropdown", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "value-request-shufflebox-model": { "type": "array", "title": "shufflebox", "description": "An array of unique identifiers for the items selected in a shufflebox of the client defined field.", "items": { "type": "string", "format": "uuid" } }, "value-request-model": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "value": { "description": "Value of the client defined field.\n- If a fieldId is provided and no value, then the value will be cleared.\n- multipleItemValues will overwrite what exists. e.g. providing an empty array will deselect all items.\n- Only CDVs sent in the request body will be updated. Any field not included will retain its value.\n- Update of attachments and single selector is not supported at this time.\n", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "string", "format": "uuid", "title": "dropdown", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, { "type": "array", "title": "shufflebox", "description": "An array of unique identifiers for the items selected in a shufflebox of the client defined field.", "items": { "type": "string", "format": "uuid" } } ] } } }, "value-list": { "type": "object", "description": "A list of client defined values for the given id.", "required": [ "maxItems", "value" ], "properties": { "maxItems": { "type": "integer" }, "value": { "type": "array", "items": { "type": "object", "title": "text", "description": "A client defined field and its string values.", "required": [ "fieldId" ], "properties": { "fieldId": { "type": "string", "format": "uuid", "description": "A unique identifier for this client defined field." }, "fieldType": { "type": "string", "enum": [ "checkBox", "date", "dropDown", "int", "money", "singleSelector", "shuffleBox", "string", "text" ], "description": "The type of client defined field." }, "fieldName": { "type": "string", "description": "The name of the client defined field.", "maxLength": 255 }, "isRequired": { "type": "boolean", "description": "A boolean that determines if this client defined field is required." }, "value": { "description": "An array of client defined values.", "anyOf": [ { "type": "string", "title": "string", "description": "The string value of the client defined field." }, { "type": "string", "title": "text", "description": "The text value of the client defined field." }, { "type": "integer", "title": "int", "description": "The integer value of the client defined field." }, { "type": "number", "title": "money", "description": "The money value of the client defined field." }, { "type": "string", "format": "date-time", "title": "date", "description": "- The date value of the client defined field.\n- Supported date format is ISO 8601.\n" }, { "type": "boolean", "title": "checkbox", "description": "The checkbox boolean value of the client defined field." }, { "type": "object", "title": "singleSelector", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a singleSelector of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "dropdown", "description": "A client defined field.", "required": [ "fieldId" ], "properties": { "itemValueId": { "type": [ "string" ], "format": "uuid", "description": "A unique identifier for the item selected in a dropdown of the client defined field." }, "itemValue": { "type": [ "string" ], "description": "The item value in a dropdown of the client defined field." } } }, { "type": "object", "title": "shufflebox", "description": "A client defined field.", "properties": { "items": { "type": "array", "items": { "type": "object", "description": "A multiple item object for shuffleBox field types.", "required": [ "itemValueId", "itemValue" ], "properties": { "itemValueId": { "type": "string", "format": "uuid", "description": "A unique identifier for this item value." }, "itemValue": { "type": [ "string" ], "description": "An item value." } } } } } } ] } } } } } }, "assignment-array-assignment-model": { "type": "object", "description": "Current state for an assignment.", "required": [ "assignmentId" ], "properties": { "assignmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the assignment.\n", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" }, "startDate": { "type": "string", "format": "date", "description": "- The start date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "endDate": { "type": "string", "format": "date", "description": "- The end date of the assignment.\n- Supported date format is ISO 8601.\n", "example": "2024-01-18" }, "statusType": { "type": "string", "enum": [ "active", "cancel", "expired", "pending", "rejected", "scheduled", "void" ], "description": "The status of this assignment.\n" } } }, "cost-center": { "type": "object", "required": [ "costCenterId" ], "properties": { "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The ou code of the cost center.", "maxLength": 50, "example": "ou1" }, "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" } } }, "location": { "type": "object", "required": [ "locationId" ], "properties": { "locationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the location.", "example": "6c077146-77aa-477c-94df-7b1102671adc" }, "locationCode": { "type": "string", "description": "The location code.", "maxLength": 233, "example": "Alameda" } } }, "supplier": { "type": "object", "required": [ "supplierId" ], "properties": { "supplierId": { "type": "string", "format": "uuid", "description": "The unique identifier of the supplier.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "supplierCode": { "type": "string", "description": "The code for this supplier.", "maxLength": 50, "example": "code123" } } }, "currency-model": { "type": "object", "required": [ "currencyId" ], "properties": { "currencyId": { "type": "string", "format": "uuid", "description": "The unique identifier of the currency.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "code": { "type": "string", "description": "The code of the currency.", "maxLength": 3, "example": "USD" } } }, "bill-rate-model": { "type": "object", "required": [ "rateId" ], "properties": { "rateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the bill rate.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "earningCodeName": { "type": "string", "description": "The earning code name of the bill rate.", "maxLength": 255, "example": "name123" }, "rate": { "type": "number", "description": "The rate of the bill rate.", "minimum": 0, "maximum": 922337203685477.6 }, "rateTypeName": { "type": "string", "description": "The rate type name of the bill rate.", "maxLength": 255, "example": "name123" } } }, "assignment-financials-cost-center-model": { "type": "object", "required": [ "costCenterNumber" ], "properties": { "costCenterNumber": { "type": "string", "description": "The cost center number of the cost center.", "maxLength": 100, "example": "abcd" }, "costCenterId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost center.", "example": "37a29a36-b084-4033-8a26-b2839cce4c21" }, "ouCode": { "type": "string", "description": "The organization unit code of the cost center.", "maxLength": 50, "example": "ou1" } } }, "cost-allocation-unit-segment-model": { "type": "object", "properties": { "segmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit segment.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "displayName": { "type": "string", "description": "The display name of the cost allocation unit segment.", "maxLength": 255, "example": "name123" }, "code": { "type": "string", "description": "The code of the cost allocation unit segment.", "maxLength": 512, "example": "code123" } } }, "cost-allocation-unit-model": { "type": "object", "properties": { "costAllocationUnitId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "share": { "type": "number", "description": "The percentage share of the cost allocation unit.", "example": 0.3867 }, "segments": { "type": "array", "description": "The segments of the cost allocation unit.", "items": { "type": "object", "properties": { "segmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit segment.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "displayName": { "type": "string", "description": "The display name of the cost allocation unit segment.", "maxLength": 255, "example": "name123" }, "code": { "type": "string", "description": "The code of the cost allocation unit segment.", "maxLength": 512, "example": "code123" } } } }, "costAllocationUnitStartDate": { "type": "string", "format": "date", "description": "- The start date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" }, "costAllocationUnitEndDate": { "type": "string", "format": "date", "description": "- The end date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" } } }, "cost-allocation-model": { "type": "object", "properties": { "costAllocationId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "units": { "type": "array", "description": "The units of the cost allocation.", "items": { "type": "object", "properties": { "costAllocationUnitId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "share": { "type": "number", "description": "The percentage share of the cost allocation unit.", "example": 0.3867 }, "segments": { "type": "array", "description": "The segments of the cost allocation unit.", "items": { "type": "object", "properties": { "segmentId": { "type": "string", "format": "uuid", "description": "The unique identifier of the cost allocation unit segment.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "displayName": { "type": "string", "description": "The display name of the cost allocation unit segment.", "maxLength": 255, "example": "name123" }, "code": { "type": "string", "description": "The code of the cost allocation unit segment.", "maxLength": 512, "example": "code123" } } } }, "costAllocationUnitStartDate": { "type": "string", "format": "date", "description": "- The start date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" }, "costAllocationUnitEndDate": { "type": "string", "format": "date", "description": "- The end date of the cost allocation unit.\n- Supported date format is ISO 8601.\n- Date must be between 1900-01-01 and 2079-06-06.\n" } } } } } }, "user-model": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "format": "uuid", "description": "The unique identifier of the user.", "example": "488c04ed-cc94-4ad0-a6b5-37c7126f7372" }, "userName": { "type": "string", "description": "The username of the user.", "maxLength": 50, "example": "username123" } } }, "amend-assignment-bteprojectcodes-model": { "type": "object", "properties": { "add": { "type": "array", "description": "Codes of BTE Projects to add to an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "123", "456" ] }, "remove": { "type": "array", "description": "Codes of BTE Projects to remove from an assignment.", "maxItems": 20, "items": { "type": "string", "maxLength": 255 }, "example": [ "111", "222" ] } } }, "assignment-budget-model": { "type": "object", "properties": { "budgetAdjustment": { "type": "string", "description": "The action to take on the assignment's budget. If no value is supplied, then this will default to \"doNotAdjustBudget\".", "enum": [ "adjustBudgetBasedOnAmendment", "adjustBudgetDecreaseOnly", "doNotAdjustBudget", "manuallyIncreaseBudget" ], "example": "manuallyIncreaseBudget" }, "budgetAdjustmentAmount": { "type": "number", "description": "Amount value budget is adjusted by. This is an optional field only required if budgetAdjustment is \"manuallyIncreaseBudget\" or \"adjustBudgetDecreaseOnly\".", "minimum": 0, "maximum": 922337203685477.6, "example": 1000 } } }, "candidate-id-model": { "type": "object", "description": "Current state for a candidate.", "required": [ "candidateId" ], "properties": { "candidateId": { "type": "string", "format": "uuid", "description": "The unique identifier of the candidate.", "example": "cac2573a-7784-440c-b9b5-928f97625dd1" } } }, "money": { "type": "object", "properties": { "currency": { "description": "The unique code that identifies the currency for the amount.", "maxLength": 3, "example": "USD" }, "amount": { "description": "The request's estimated cost amount in the currency.", "type": "number", "example": 12345.67 } } }, "inner-error": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } }, "error-inner": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } }, "error-response-inner": { "type": "object", "description": "An Error Response.", "required": [ "error" ], "properties": { "error": { "type": "object", "description": "The Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "type": "object", "description": "The Specific Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } }, "innerError": { "type": "object", "description": "An object containing more specific information than the current object about the error.", "properties": { "code": { "type": "string", "description": "A more specific error code than was provided by the containing error." }, "innerError": { "type": "object", "description": "The Inner Error object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes" }, "message": { "type": "string", "description": "a human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." } } } } } } } } } }, "examples": { "amend-assignment-cdvs-request": { "value": { "amendmentEffectiveDate": "2023-01-18", "amendmentEndDate": "2023-01-18", "clientDefinedValues": [ { "fieldId": "111111-2222-3333-4444-555555555555", "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": 100.5 }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": "111111-2222-3333-4444-555555555555" }, { "fieldId": "111111-2222-3333-4444-555555555555", "value": { "items": [ "111111-2222-3333-4444-555555555555", "111111-2222-3333-4444-555555555555" ] } } ], "comment": "Example string comment" } }, "client-defined-value-string-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" } }, "client-defined-value-text-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" } }, "client-defined-value-int-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 } }, "client-defined-value-date-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" } }, "client-defined-value-money-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 } }, "client-defined-value-checkbox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkBox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true } }, "client-defined-value-dropdown-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } } }, "client-defined-value-single-selector-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } } }, "client-defined-value-shufflebox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } }, "client-defined-value-list": { "value": { "maxItems": 9, "value": [ { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkbox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } ] } }, "update-request-cdvs-request": { "value": { "clientDefinedValues": [ { "fieldId": "550e8400-e29b-41d4-a716-446655440000", "value": "some string value" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440001", "value": "some larger text value" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440002", "value": 87366 }, { "fieldId": "550e8400-e29b-41d4-a716-446655440003", "value": "2023-01-18T00:00:00Z" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440004", "value": 100.5 }, { "fieldId": "550e8400-e29b-41d4-a716-446655440005", "value": true }, { "fieldId": "550e8400-e29b-41d4-a716-446655440006", "value": "550e8400-e29b-41d4-a716-446655440006" }, { "fieldId": "550e8400-e29b-41d4-a716-446655440007", "value": [ "550e8400-e29b-41d4-a716-446655440008", "550e8400-e29b-41d4-a716-446655440009" ] } ] } }, "value-string-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" } }, "value-text-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" } }, "value-int-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 } }, "value-money-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 } }, "value-date-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" } }, "value-checkbox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkBox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true } }, "value-single-selector-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } } }, "value-dropdown-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } } }, "value-shufflebox-field": { "value": { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } }, "rate-limit-error-response": { "value": { "errors": [ { "code": "REQUEST_LIMIT_EXCEEDED", "message": "API calls quota exceeded! Maximum admitted 1000 per 1m." } ] } }, "value-list": { "value": { "maxItems": 9, "value": [ { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "string", "fieldName": "Example String CDV Field", "isRequired": true, "value": "some string value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "text", "fieldName": "Example Text CDV Field", "isRequired": true, "value": "some larger text value" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "int", "fieldName": "Example Int CDV Field", "isRequired": true, "value": 87366 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "date", "fieldName": "Example Date CDV Field", "isRequired": true, "value": "2023-01-18T17:59:51.753Z" }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "money", "fieldName": "Example Money CDV Field", "isRequired": true, "value": 100 }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "checkbox", "fieldName": "Example CheckBox CDV Field", "isRequired": true, "value": true }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "singleSelector", "fieldName": "Example SingleSelector CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example SingleSelector Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "dropDown", "fieldName": "Example DropDown CDV Field", "isRequired": true, "value": { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example Dropdown Value" } }, { "fieldId": "111111-2222-3333-4444-555555555555", "fieldType": "shuffleBox", "fieldName": "Example ShuffleBox CDV Field", "isRequired": true, "value": { "items": [ { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" }, { "itemValueId": "111111-2222-3333-4444-555555555555", "itemValue": "Example ShuffleBox Value" } ] } } ] } } }, "securitySchemes": { "client_auth": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://integrations.auth.beeline.com/oauth/token", "scopes": { "read:client_defined": "Read Client Defined data", "write:client_defined": "Read or Write Client Defined data", "read:assignment": "Read Assignment data", "read:candidate": "Read Candidate data", "read:request": "Read Request data", "write:request": "Write Request data", "read:worker": "Read Worker data", "write:worker": "Write Worker data", "read:intake-form": "Read Intake Form", "write:intake-form": "Write Intake Form" } } } } } } }