Job

Returns a list of all jobs.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

Optionally filter the returned list of jobs by business unit

Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/jobs
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Create a new job.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
required
businessUnitId
required
string <uuid> 
The business unit ID associated with the Job.


 
code
required
string
The code.


 
altCode
string or null
The alt code.


 
description
string or null
An optional description.


 
enabled
string or null
Enabled? (Y/N)


 
regionCode
string or null
An optional region.


 
divisionCode
string or null
An optional division.


 
object (ApiAddressRead) 
A representation of an Address object returned by the API.


 
status
string or null
The current status of the job.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/jobs
Request samples 
{
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "code": "string",
  • "altCode": "string",
  • "description": "string",
  • "enabled": "string",
  • "regionCode": "string",
  • "divisionCode": "string",
  • "address": {
    },
  • "status": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "code": "string",
  • "altCode": "string",
  • "description": "string",
  • "enabled": "string",
  • "regionCode": "string",
  • "divisionCode": "string",
  • "address": {
    },
  • "status": "string"
}
Update an existing job.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The job guid.


 
Request Body schema: 
required
code
string or null
The code.


 
altCode
string or null
The alt code.


 
description
string or null
An optional description.


 
enabled
string or null
Enabled? (Y/N)


 
regionCode
string or null
An optional region.


 
divisionCode
string or null
An optional division.


 
object (ApiAddressRead) 
A representation of an Address object returned by the API.


 
status
string or null
The current status of the job.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


put/api/v1/jobs/{id}
Request samples 
{
  • "code": "string",
  • "altCode": "string",
  • "description": "string",
  • "enabled": "string",
  • "regionCode": "string",
  • "divisionCode": "string",
  • "address": {
    },
  • "status": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "code": "string",
  • "altCode": "string",
  • "description": "string",
  • "enabled": "string",
  • "regionCode": "string",
  • "divisionCode": "string",
  • "address": {
    },
  • "status": "string"
}