Workday

This Connector allows you to interact with the Workday API. This connector is based on the Workday Rest API and uses version v1.

Prerequisites

The Workday asset requires an Host, Private Key, Client ID, and an org to interact with the API.

Capabilities

This connector provides the following capabilities:

Get Activities for a Specific Customer

Get Activity for Customer

Get Customer

Get Direct Reports for Worker

Get History Items for Worker

Get Leave Status

Get Organization by ID

Get Organizations

Get Organizations for Worker

Get Pay Slips for Worker

Get Time Off Entires for Worker

Get Values Time off Status

Get Worker by ID

Get Workers

Get Workers Eligible Absence Types ... and so on

Notes

For more information on Workday API : Click here!

Configurations

Oauth 2.0 Client Credentials

Authenticates using oauth 2.0 client credentials

Configuration Parameters

Parameter	Description	Type	Required
host	Server Host Address	string	Required
private_key	Also created when you create a new Application in Cred Admin. You must save this key immedately upon creation of an Application. Workday does not hold this key for you.	string	Required
client_id	This is created when you create a new Application in Cred Admin	string	Required
org	This will be in your cred admin url. For example https://credentials.workday.com/gms/applications. In this case, the organization is gms.	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Get Activities For A Specific Customer

Get activities for a specific customer.

Endpoint

URL: /api/common/v1/gms/customers/{{ID}}/activities

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
parameters.fromDate	string	Optional	Parameters for the Get Activities For A Specific Customer action
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
parameters.toDate	string	Optional	Parameters for the Get Activities For A Specific Customer action

Input Example

{"parameters":{"fromDate":"2023-10-28T07:00:00.000Z","limit":20,"offset":9,"toDate":"2023-11-28T07:00:00.000Z"},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.invoiceOpportunity	object	Response data
data.invoiceOpportunity.name	string	Response data
data.invoiceOpportunity.id	string	Response data
data.invoiceOpportunity.opportunityReferenceID	string	Response data
data.paymentReference	string	Response data
data.transactionAmountSigned	string	Response data
data.transactionDate	string	Response data
data.applicationStatus	string	Response data
data.transactionType	string	Response data
data.transactionStatus	string	Response data
data.transactionNumber	string	Response data
data.invoiceDueDate	string	Response data
data.id	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Activity For Customer

Retrieves an activity instance for a specific customer.

Endpoint

URL: /api/common/v1/gms/customers/{{ID}}/activities/{{subresourceID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
path_parameters.subresourceID	string	Optional	The Workday ID of the subresource.

Input Example

{"path_parameters":{"ID":"16536","subresourceID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
invoiceOpportunity	object	Output field: invoiceOpportunity
invoiceOpportunity.name	string	Name of the resource
invoiceOpportunity.id	string	Unique identifier
invoiceOpportunity.opportunityReferenceID	string	Unique identifier
paymentReference	string	Output field: paymentReference
transactionAmountSigned	string	Output field: transactionAmountSigned
transactionDate	string	Date value
applicationStatus	string	Status value
transactionType	string	Type of the resource
transactionStatus	string	Status value
transactionNumber	string	Output field: transactionNumber
invoiceDueDate	string	Date value
id	string	Unique identifier

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"invoiceOpportunity":{"name":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co...","id":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co...","opportunityReferenceID":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co..."},"paymentReference":...

Get Customer

Retrieves a customer instance.

Endpoint

URL: api/common/v1/gms/customers/{{ID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.

Input Example

{"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
name	string	Name of the resource
id	string	Unique identifier
descriptor	string	Output field: descriptor

Output Example

Get Direct Reports for Worker

Retrieves a collection of workers and current staffing information.

Endpoint

URL: /api/common/v1/gms/workers/{{ID}}/directReports

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
parameters.limit	number	Optional	Parameters for the Get Direct Reports for Worker action
parameters.offset	number	Optional	Parameters for the Get Direct Reports for Worker action
parameters.search	string	Optional	Parameters for the Get Direct Reports for Worker action

Input Example

{"parameters":{"limit":20,"offset":9,"search":"Search"},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.primaryWorkPhone	string	Response data
data.isManager	boolean	Response data
data.primaryWorkEmail	string	Response data
data.businessTitle	string	Response data
data.primarySupervisoryOrganization	object	Response data
data.primarySupervisoryOrganization.id	string	Response data
data.primarySupervisoryOrganization.descriptor	string	Response data
data.primarySupervisoryOrganization.href	string	Response data
data.id	string	Response data
data.descriptor	string	Response data
data.href	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get History Items For Worker

Retrieves all history items for the worker.

Endpoint

URL: /api/common/v1/gms/workers/{{ID}}/history

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
parameters.limit	number	Optional	Parameters for the Get History Items For Worker action
parameters.offset	number	Optional	Parameters for the Get History Items For Worker action

Input Example

{"parameters":{"limit":20,"offset":9},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.subject	object	Response data
data.subject.id	string	Response data
data.subject.descriptor	string	Response data
data.subject.href	string	Response data
data.initiator	object	Response data
data.initiator.id	string	Response data
data.initiator.descriptor	string	Response data
data.initiator.href	string	Response data
data.effective	string	Response data
data.due	string	Response data
data.initiated	string	Response data
data.descriptor	string	Response data
data.id	string	Response data
data.href	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Leave Status

Get Leave Status IDs.

Endpoint

URL: /api/absenceManagement/v1/gms/values/leave/status

Method: GET

Input

Argument Name	Type	Required	Description
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"limit":20,"offset":9}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
total	number	Output field: total
data	array	Response data
data.id	string	Response data
data.descriptor	string	Response data
data.href	string	Response data

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"total":0,"data":[{}]}}

Get Organization By ID

Retrieves an organization instance.

Endpoint

URL: /api/common/v1/gms/organizations/{{ID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.

Input Example

{"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
href	string	Output field: href
descriptor	string	Output field: descriptor

Output Example

Get Organizations

Retrieves a collection of organizations.

Endpoint

URL: /api/common/v1/gms/organizations

Method: GET

Input

Argument Name	Type	Required	Description
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"limit":20,"offset":9}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.id	string	Response data
data.href	string	Response data
data.descriptor	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Organizations For Worker

Retrieves all organizations for a specific worker.

Endpoint

URL: /api/common/v1/gms/workers/{{ID}}/organizations

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	Parameters for the Get Organizations For Worker action
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"limit":20,"offset":9},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.organizationType	object	Response data
data.organizationType.id	string	Response data
data.organizationType.descriptor	string	Response data
data.organizationType.href	string	Response data
data.id	string	Response data
data.href	string	Response data
data.descriptor	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Pay Slips For Worker

Retrieves all pay slips for a worker with the specified ID.

Endpoint

URL: /api/common/v1/gms/workers/{{ID}}/paySlips

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"limit":20,"offset":9},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.gross	string	Response data
data.status	object	Response data
data.status.id	string	Response data
data.status.descriptor	string	Response data
data.status.href	string	Response data
data.net	string	Response data
data.date	string	Response data
data.descriptor	string	Response data
data.id	string	Response data
data.href	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Time Off Entires For Worker

Retrieves a collection of time off entries for a specific worker.

Endpoint

URL: /api/common/v1/gms/workers/{{ID}}/timeOffEntries

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"limit":20,"offset":9},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.units	string	Response data
data.employee	object	Response data
data.employee.id	string	Response data
data.employee.descriptor	string	Response data
data.employee.href	string	Response data
data.unitOfTime	object	Response data
data.unitOfTime.id	string	Response data
data.unitOfTime.descriptor	string	Response data
data.unitOfTime.href	string	Response data
data.timeOffRequest	object	Response data
data.timeOffRequest.status	string	Response data
data.timeOffRequest.id	string	Response data
data.timeOffRequest.href	string	Response data
data.timeOffRequest.descriptor	string	Response data
data.date	string	Response data
data.timeOff	object	Response data
data.timeOff.plan	object	Response data
data.timeOff.plan.id	string	Response data
data.timeOff.plan.descriptor	string	Response data
data.timeOff.plan.href	string	Response data
data.timeOff.id	string	Response data
data.timeOff.href	string	Response data

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Values Time off Status

Get Time Off Status values.

Endpoint

URL: /api/absenceManagement/v1/gms/values/leave/status

Method: GET

Input

Argument Name	Type	Required	Description
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"limit":20,"offset":9}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
total	number	Output field: total
data	array	Response data
data.id	string	Response data
data.descriptor	string	Response data
data.href	string	Response data

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"total":0,"data":[{}]}}

Get Worker By ID

Retrieves a worker instance with the specific ID.

Endpoint

URL: /api/common/v1/gms/workers/{{ID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.

Input Example

{"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
primaryWorkEmail	string	Output field: primaryWorkEmail
isManager	boolean	Output field: isManager
primaryWorkPhone	string	Output field: primaryWorkPhone
location	object	Output field: location
location.id	string	Unique identifier
location.descriptor	string	Output field: location.descriptor
location.href	string	Output field: location.href
primarySupervisoryOrganization	object	Output field: primarySupervisoryOrganization
primarySupervisoryOrganization.id	string	Unique identifier
primarySupervisoryOrganization.descriptor	string	Output field: primarySupervisoryOrganization.descriptor
primarySupervisoryOrganization.href	string	Output field: primarySupervisoryOrganization.href
primaryWorkAddressText	string	Output field: primaryWorkAddressText
yearsOfService	string	Output field: yearsOfService
businessTitle	string	Output field: businessTitle
supervisoryOrganizationsManaged	string	Output field: supervisoryOrganizationsManaged
dateOfBirth	string	Output field: dateOfBirth
id	string	Unique identifier
href	string	Output field: href
descriptor	string	Output field: descriptor

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"primaryWorkEmail":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co...","isManager":true,"primaryWorkPhone":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co...","location":{"id":"^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$","descriptor":"string","href":"string...

Get Workers

Retrieves a collection of workers and current staffing information.

Endpoint

URL: /api/common/v1/gms/workers

Method: GET

Input

Argument Name	Type	Required	Description
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
parameters.search	string	Optional	Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.

Input Example

{"parameters":{"limit":20,"offset":9,"search":"Search"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.primaryWorkPhone	string	Response data
data.isManager	boolean	Response data
data.primaryWorkEmail	string	Response data
data.businessTitle	string	Response data
data.primarySupervisoryOrganization	object	Response data
data.primarySupervisoryOrganization.id	string	Response data
data.primarySupervisoryOrganization.descriptor	string	Response data
data.primarySupervisoryOrganization.href	string	Response data
data.id	string	Response data
data.descriptor	string	Response data
data.href	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Workers Eligible Absence Types

Retrieves all the eligible absence types for the specified worker ID for a category type.

Endpoint

URL: /api/absenceManagement/v1/gms/workers/{{ID}}/eligibleAbsenceTypes

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	Parameters for the Get Workers Eligible Absence Types action
parameters.category	string	Optional	The Workday ID of the absence type category. Valid values Leave of Absence Type 17bd6531c90c100016d74f8dfae007d0, Absence Table 17bd6531c90c100016da3f5b554007d2, Time Off 17bd6531c90c100016d4b06f2b8a07ce.
parameters.effective	string	Optional	The effective date for which eligible absence types need to be returned for the worker.
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Input Example

{"parameters":{"category":"17bd6531c90c100016d74f8dfae007d0","effective":"2023-10-28T07:00:00.000Z","limit":20,"offset":9},"path_parameters":{"ID":"16536"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.unitOfTime	object	Response data
data.unitOfTime.id	string	Response data
data.unitOfTime.descriptor	string	Response data
data.unitOfTime.href	string	Response data
data.positionBased	boolean	Response data
data.position	array	Response data
data.position.descriptor	string	Response data
data.position.id	string	Response data
data.absenceReasons	array	Response data
data.absenceReasons.descriptor	string	Response data
data.absenceReasons.id	string	Response data
data.reasonRequired	boolean	Response data
data.displayStartAndEndTime	boolean	Response data
data.id	string	Response data
data.category	object	Response data
data.category.id	string	Response data
data.category.descriptor	string	Response data
data.category.href	string	Response data
data.additionalFields	array	Response data
data.additionalFields.required	boolean	Response data
data.additionalFields.descriptor	string	Response data
data.additionalFields.id	string	Response data

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Get Workers Eligible Absense Types By SubResource

Retrieves information about an eligible absence type for the worker with the specified ID.

Endpoint

URL: /api/absenceManagement/v1/gms/workers/{{ID}}/eligibleAbsenceTypes/{{subresourceID}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ID	string	Required	The Workday ID of the resource.
path_parameters.subresourceID	string	Required	The Workday ID of the subresource.

Input Example

{"path_parameters":{"ID":"16536","subresourceID":"Sub Resource ID"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
unitOfTime	object	Time value
unitOfTime.id	string	Unique identifier
unitOfTime.descriptor	string	Output field: unitOfTime.descriptor
unitOfTime.href	string	Output field: unitOfTime.href
positionBased	boolean	Output field: positionBased
position	array	Output field: position
position.descriptor	string	Output field: position.descriptor
position.id	string	Unique identifier
absenceReasons	array	Response reason phrase
absenceReasons.descriptor	string	Response reason phrase
absenceReasons.id	string	Unique identifier
reasonRequired	boolean	Response reason phrase
displayStartAndEndTime	boolean	Time value
id	string	Unique identifier
category	object	Output field: category
category.id	string	Unique identifier
category.descriptor	string	Output field: category.descriptor
category.href	string	Output field: category.href
additionalFields	array	Output field: additionalFields
additionalFields.required	boolean	Output field: additionalFields.required
additionalFields.descriptor	string	Output field: additionalFields.descriptor
additionalFields.id	string	Unique identifier
dailyDefaultQuantity	string	Output field: dailyDefaultQuantity

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"unitOfTime":{"id":"^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$","descriptor":"string","href":"string"},"positionBased":true,"position":[{}],"absenceReasons":[{}],"reasonRequired":true,"displayStartAndEndTime":true,"id":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque co...","category":{"id":"^(...

Get WQL Queries

Returns the data from a WQL query.

Endpoint

URL: /api/wql/v1/gms/data

Method: GET

Input

Argument Name	Type	Required	Description
parameters.limit	number	Optional	The maximum number of objects in a single response. The default is 20. The maximum is 100.
parameters.offset	number	Optional	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
parameters.query	string	Optional	The WQL query that retrieves the data.

Input Example

{"parameters":{"limit":20,"offset":9,"query":"SELECT worker from allWorkers"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
data	array	Response data
data.id	string	Response data
data.descriptor	string	Response data
data.href	string	Response data
total	number	Output field: total

Output Example

{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 30 oct 2023 20:37:23 GMT"},"reason":"OK","json_body":{"data":[{}],"total":0}}

Post WQL Query

Returns the data from a WQL query. The read-only POST request accommodates queries greater than 2,048 characters. You can only view data you have security access to.

Endpoint

URL: /api/wql/v1/gms/data

Method: POST

Input

Argument Name	Type	Required	Description
query	string	Optional	Parameter for Post WQL Query

Input Example

{"json_body":{"query":"Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
query	string	Output field: query

Output Example

Response Headers

Header	Description	Example
content-length	The length of the response body in bytes	140
content-type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Wed, 30 oct 2023 20:37:23 GMT