v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Jobs

Get VMS Jobs by VMS ID

Returns details about the VMS jobs associated with the specified VMS ID.

get/v1/job/vms-jobs/{vmsId}

vmsIdstring nullable required

The job identifier from the external VMS system.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

An array of VMS Jobs for the requested VMS ID.

vmsJobIdinteger

The VMS job identifier.

vmsIdstring nullable

The VMS identifier (external system identifier).

jobIdinteger nullable

The Bold job identifier, if the VMS job has been actioned.

vmsCompanystring nullable

The VMS company name.

titlestring nullable

The job title.

statusstring nullable

The job status name.

positionsinteger

The number of positions available.

startDatestring date-time

The job start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endDatestring date-time

The job end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

vmsNotesstring nullable

Notes related to the VMS job.

vmsNamestring nullable

The VMS name (e.g., "SimpleVMS", "JobRobotix").

vendorIdinteger nullable

The vendor identifier.