Skip to content

Latest commit

 

History

History
481 lines (334 loc) · 21.3 KB

WorkdayImportApi.md

File metadata and controls

481 lines (334 loc) · 21.3 KB

\WorkdayImportApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
WorkdaysAuthorize Post /workdays/{workday_id}/auth Authorize Workday
WorkdaysDeauthorize Delete /workdays/{workday_id}/auth Deauthorize Workday
WorkdaysDelete Delete /workdays/{id} Delete Workday
WorkdaysGet Get /workdays/{id} Get Workday
WorkdaysImport Post /workdays/{workday_id}/import Workday Import
WorkdaysImportresults Get /workdays/{id}/import/{job_id}/results List Import Results
WorkdaysList Get /workdays List Workdays
WorkdaysPost Post /workdays Create new Workday
WorkdaysPut Put /workdays/{id} Update Workday
WorkdaysSettings Get /workdays/settings Get Workday Settings (incomplete)
WorkdaysWorkers Get /workdays/{workday_id}/workers List Workday Workers

WorkdaysAuthorize

WorkdaysAuthorize(ctx, workdayId, contentType, accept, optional) Authorize Workday

This endpoint adds an authorization method to a workday instance. You must supply a username and password for Basic Authentication that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently O-Auth isn't a supported authentication protocol for WorkDay, but will be in the future. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"auth\":{ \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
body AuthInputObject
xOrgId string [default to ]

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysDeauthorize

WorkdaysDeauthorize(ctx, workdayId, contentType, accept, optional) Deauthorize Workday

Removes any and all authorization methods from the workday instance ##### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/auth \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysDelete

interface{} WorkdaysDelete(ctx, id, contentType, accept, optional) Delete Workday

This endpoint allows you to delete an instance of Workday. This functionality is currently not enable for users.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

interface{}

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysGet

WorkdayOutput WorkdaysGet(ctx, id, contentType, accept, optional) Get Workday

This endpoint will return all the available information about an instance of Workday. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

WorkdayOutput

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysImport

JobId WorkdaysImport(ctx, workdayId, contentType, accept, optional) Workday Import

The endpoint allows you to create a Workday Import request. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '[ { \"email\":\"{email}\", \"firstname\":\"{firstname}\", \"lastname\":\"{firstname}\", \"username\":\"{username}\", \"attributes\":[ {\"name\":\"EmployeeID\",\"value\":\"0000\"}, {\"name\":\"WorkdayID\",\"value\":\"name.name\"} ] } ]

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
body []BulkUserCreate
xOrgId string [default to ]

Return type

JobId

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysImportresults

[]JobWorkresult WorkdaysImportresults(ctx, id, jobId, contentType, accept, optional) List Import Results

This endpoint provides a list of job results from the workday import and will contain all imported data from Workday. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkdayID}/import/{ImportJobID}/results \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
jobId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
jobId string
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]JobWorkresult

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysList

[]WorkdayOutput WorkdaysList(ctx, contentType, accept, optional) List Workdays

This endpoint will return all the available information about all your instances of Workday. ##### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
fields []string The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
filter []string Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
xOrgId string [default to ]

Return type

[]WorkdayOutput

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysPost

WorkdaysPost(ctx, contentType, accept, optional) Create new Workday

This endpoint allows you to create a new workday instance. You must supply a username and password for Basic Authentication that is the same as your WorkDay Integrator System User. Failure to provide these credentials will result in the request being rejected. Currently O-Auth isn't a supported authentication protocol for WorkDay, but will be in the future. Currently, only one instance is allowed and it must be Workday Import. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/workdays/ \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Workday2\", \"reportUrl\":\"https://workday.com/ccx/service/customreport2/gms/user/reportname?format=json\", \"auth\": { \"basic\": { \"username\": \"someDeveloper\", \"password\": \"notTheRealPassword\" } } }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
body WorkdayInput
xOrgId string [default to ]

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysPut

WorkdayOutput WorkdaysPut(ctx, id, contentType, accept, optional) Update Workday

This endpoint allows you to update the name and Custom Report URL for a Workday Instance. Currently, the name can not be changed from the default of Workday Import. ##### Sample Request curl -X PUT https://console.jumpcloud.com/api/v2/workdays/{WorkdayID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"reportUrl\":\"{Report_URL}\", \"name\":\"{Name}\" } '

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
contentType string [default to application/json]
accept string [default to application/json]
body WorkdayFields
xOrgId string [default to ]

Return type

WorkdayOutput

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysSettings

WorkdaysSettings(ctx, contentType, accept, optional) Get Workday Settings (incomplete)

This endpoint allows you to obtain all settings needed for creating a workday instance, specifically the URL to initiate Basic Authentication with WorkDay. This functionality is currently not enable for users.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
state string
xOrgId string [default to ]

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WorkdaysWorkers

[]WorkdayWorker WorkdaysWorkers(ctx, workdayId, contentType, accept, optional) List Workday Workers

This endpoint will return all of the data in your WorkDay Custom Report that has been associated with your WorkDay Instance in JumpCloud. ##### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/workdays/{WorkDayID}/workers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
workdayId string
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
sort []string The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending.
xOrgId string [default to ]

Return type

[]WorkdayWorker

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]