AMCS Group Job API
The Job API from AMCS Group — 8 operation(s) for job.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup Job API
version: core
tags:
- name: Job
paths:
/jobsystem/jobs/changes:
get:
tags:
- Job
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
- name: links
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges[ApiJobResource]'
/jobsystem/jobs/template:
get:
tags:
- Job
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResult[ApiJobResource]'
/jobsystem/jobs/{id}:
get:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: links
in: query
schema:
type: string
- name: include
in: query
schema:
type: string
- name: expand
in: query
schema:
type: string
- name: udf
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity[ApiJobResource]'
put:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
delete:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResource'
/jobsystem/jobs/{id}/blob/{blobMemberName}:
get:
tags:
- Job
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: blobMemberName
in: path
required: true
schema:
type: string
- name: fileName
in: query
schema:
type: string
- name: contentType
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: string
format: binary
/jobsystem/jobs:
get:
tags:
- Job
parameters:
- name: filter
in: query
schema:
type: string
- name: search
in: query
schema:
type: string
- name: order
in: query
schema:
type: string
- name: max
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: includeCount
in: query
schema:
type: string
- name: includeDeleted
in: query
schema:
type: string
- name: links
in: query
schema:
type: string
- name: udf
in: query
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection[ApiJobResource]'
post:
tags:
- Job
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/transport/jobs/changes:
get:
tags:
- Job
summary: Retrieve changes
description: "| Property| Description|\r\n| ---------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------|\r\n| GUID| The GUID associated to the job.|\r\n| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.|\r\n| InProgress| Is the job in progress?|\r\n| IsAdhoc| Is the job ad hoc?|\r\n| IsCompleted| Is the job completed?Filterable.|\r\n| CompletedDate| The completed date of the job|\r\n| IsConfirmed| Is the job confirmed?|\r\n| IsExternalTransport| Is the job using external transport?|\r\n| IsFinanciallyConfirmed| Is the job financially confirmed?|\r\n| IsHazardousPaperworkComplete| Is the hazardous paperwork complete?|\r\n| IsScheduledTransfer| Is the job a scheduled transfer?|\r\n| IsWarranty| Is the job a warranty?|\r\n| IsDeleted| Whether to delete the job|\r\n| DeleteReasonGuid| The GUID of delete reason|\r\n| RelatedPONumberGuid| The GUID of related PONumber associated to the job. Filterable.|\r\n| RelatedRouteVisitGuid| The GUID of related routeVisit associated to the job. Filterable.|\r\n| RelatedScheduleGuid| The GUID of related schedule associated to the job. Filterable.|\r\n| RelatedSiteOrderGuid| The GUID of related siteorder associated to the job. Filterable.|\r\n| RelatedSiteOrderItemGuid| The GUID of related siteorder item associated to the job. Filterable.|\r\n| RelatedSupplierSiteTransportGuid| The GUID of related supplier site transport associated to the job. Filterable.|\r\n| RelatedExternalVehicleGuid| The GUID of related external vehicle associated to the job. Filterable.|\r\n| ActionListItem| The GUID and description of the action associated to the job.| \r\n| CancelledReasonListItem| The GUID and description of the cancellation reason associated to the job. |\r\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the job. |\r\n| ContainerTypeListItem| The GUID and description of the container type associated to the job. |\r\n| DepartmentListItem| The GUID and description of the department associated to the job. |\r\n| MaterialListItem| The GUID and description of the material associated to the job. |\r\n| PaymentTypeListItem| The GUID and description of the payment type associated to the job. |\r\n| RepairReasonListItem| The GUID and description of the repair reason associated to the job. |\r\n| Access[]| The array of job access time associated to the job.|\r\n| Access[0].Contact| The contact associated to the job access time.|\r\n| Access[0].StartTime| The start time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\r\n| Access[0].EndTime| The end time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\r\n| Access[0].Notes| The notes time associated to the job access time.|\r\n| Access[0].DayOfWeekId | The day of the week associated to the job access time.|\r\n| Access[0].GUID| The Guid associated to the job access time.|\r\n| ContainerDetails| The container details object associated to the job.|\r\n| ContainerDetails.Delivered| The container delivered to the job.|\r\n| ContainerDetails.Delivered.RelatedContainerGuid| The GUID of the container delivered to the job.|\r\n| ContainerDetails.Delivered.ContainerTypeListItem| The GUID and description of the container type delivered to the job.|\r\n| ContainerDetails.Delivered.Notes| The delivered container notes.|\r\n| ContainerDetails.Delivered.SerialNo| The delivered container serial number.|\r\n| ContainerDetails.Delivered.Tag| The delivered container tag.|\r\n| ContainerDetails.Removed| The container removed from the job.|\r\n| ContainerDetails.Removed.RelatedContainerGuid| The GUID of the container removed from the job.|\r\n| ContainerDetails.Removed.ContainerTypeListItem| The GUID and description of the container type removed from to the job.|\r\n| ContainerDetails.Removed.Notes| The removed container notes.|\r\n| ContainerDetails.Removed.SerialNo| The removed container serial number.|\r\n| ContainerDetails.Removed.Tag| The removed container tag.|\r\n| VisitDetails| The visit details object associated to the job.|\r\n| VisitDetails.DriverNotes| The driver notes on the visit associated to the job.|\r\n| VisitDetails.TimeInCustomerSite| The time in on the visit associated to the job.|\r\n| VisitDetails.TimeOutCustomerSite| The time out on the visit associated to the job.|\r\n| VisitDetails.HoursChargable| The hours chargeable on the visit associated to the job.|\r\n| VisitDetails.HoursNotChargable| The hours not chargeable on the visit associated to the job.|\r\n| CustomerOrderNo| The customer order number associated to the job. Filterable.|\r\n| DateRequired| The date the job is required.|\r\n| HazardousLoadReference| The hazardous load reference associated to the job. Filterable.|\r\n| ManualTicketNo| The manual ticket number associated to the job. Filterable. |\r\n| Notes| The notes associated to the job. Filterable.|\r\n| PONumber| The PO number associated to the job.|\r\n| Quantity| The quantity associated to the job.|\r\n| ReleaseNumber| The release number associated to the job.|\r\n| TicketNo| The ticket number associated to the job. Filterable. |\r\n| RejectedReasonListItem| The GUID and description of the job rejection reason. |\r\n| RelatedLocationDestinationGuid| Used to filter the related destination location guid associated to the job. Filterable.|\r\n| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the job.|\r\n| RelatedPictureBlobHashes[0].Description| The description of the blob.|\r\n| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\r\n| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the job.|\r\n| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the job.|\r\n| PriceOverrides| The array of price overrides associated to the job.|\r\n| PriceOverrides[0].RelatedPriceGuid| The GUID of the price associated to the job price override.|\r\n| PriceOverrides[0].OverrideRate| The override rate associated to the job price override.|\r\n| PriceOverrides[0].Guid| The GUID associated to the job price override.|\r\n| PriceOverrides[0].IsSelected| The price isselected associated to the job price override.|\r\n| PriceOverrides[0].Breakdowns| The array of price breakdowns associated to the job price.|\r\n| PriceOverrides[0].Breakdowns[0].Guid| The GUID associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].IsDeleted| Whether the price breakdown is deleted.|\r\n| PriceOverrides[0].Breakdowns[0].FillLevel| The fill level associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].Quantity| The quantity associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].IsReceived| Whether the price breakdown is received.|\r\n| PriceOverrides[0].Breakdowns[0].Barcode| The BarCode associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].JobPriceBreakdownTypeEnum| The Job Price Breakdown Type associated to the price breakdown.|\r\n| RelatedPriceGuidFilter| Used to filter on the related price GUID.|\r\n| RelatedBlobJobDocketPdfHashes| The array of related job docket blob hashes.|\r\n| RelatedBlobJobDocketPdfHashes[0].Hash| The hash of the job docket blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\r\n| RelatedWTNBlobHashes| The array of related waste transfer note blob hashes.|\r\n| RelatedWTNBlobHashes[0].Guid| The guid of the job waste transfer note blob.|\r\n| RelatedWTNBlobHashes[0].Hash| The hash of the job waste transfer note blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\r\n| VATIntendedListItem| The GUID and description (code + rate) of the VAT associated to the job.|\r\n| RequiredStartTime| The start time at which the job is required.|\r\n| RequiredEndTime| The end time at which the job is required.|\r\n| ServiceListItem| The GUID and description of the Service associated to the job.|\r\n| LastChangeReasonListItem| The GUID and description of the last change reason associated to the job. |\r\n| LinkedJobs| The array of linked jobs associated to the job.|\r\n| LinkedJobs[0].Guid| The guid of the linked job associated to the job.|\r\n| LinkedJobs[0].IsDeleted| Whether the linked job is deleted.|\r\n| LinkedJobs[0].RelatedJobGuid| The job guid of the linked job associated to the job.|\r\n| Position| The position associated to the job.|\r\n| RelatedCreatedByUserGuid| The created by sys user guid associated to the job. Filterable.|\r\n| LinkedJobGuidFilter| Used to filter on linked job guid.|\r\n| RelatedJobGuidFilter| Used to filer on the job guid of the linked job.|\r\n| MaterialSaleSlots| The array of material sale slots associated to the job.|\r\n| MaterialSaleSlots[0].SlotNumber| The slot number associated to the jobmaterial sale slot.|\r\n| MaterialSaleSlots[0].SlotDate| The slot date associated to the job material sale slot.|\r\n| MaterialSaleSlots[0].SlotTime| The slot time associated to the job material sale slot.|\r\n| MaterialSaleSlots[0].CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the material sale slot. |\r\n| MaterialSaleSlots[0].MaterialListItem| The GUID and description of the Material associated to the material sale slot.|\r\n| MaterialSaleSlots[0].Notes| The notes associated to the job.|\r\n| MaterialSaleSlots[0].RelatedBookingSlotGuid| The guid of booking slot associated to the material sale slot.|\r\n| MaterialSaleSlots[0].RelatedCustomerGuid| The guid of customer associated to the material sale slot.|\r\n| MaterialSaleSlots[0].IsSchedule| The Schedule of material sale slots associated to the job.|\r\n| MaterialSaleSlots[0].IsManuallyAssigned| The IsManuallyAssigned of material sale slots associated to the job.|\r\n| MaterialSaleSlots[0].IsDeleted| Whether the material sale slot is deleted.|\r\n| MaterialSaleSlots[0].Guid| The GUID associated to the material sale slot.|\r\n| MaterialSaleSlotSlotNumberFilter| Used to filter on the material sale slot slot number.|\r\n| MaterialSaleSlotGuidFilter| Used to filter on the material sale slot guid.|\r\n| MaterialSaleSlotRelatedBookingSlotGuidFilter| Used to filter on the material sale slot related booking slot guid.|\r\n| MaterialSaleSlotRelatedCustomerGuidFilter| Used to filter on the material sale slot related customer guid.|\r\n| PriorityListItem| The GUID and description of the priority associated to the job. |\r\n| DriverFeedback| The driver feedback associated to the job. |"
operationId: Job_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges[ApiIntegratorJobResource]'
/transport/jobs/{guid}:
get:
tags:
- Job
summary: Find with GUID
description: "| Property| Description|\r\n| ---------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------|\r\n| GUID| The GUID associated to the job.|\r\n| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.|\r\n| InProgress| Is the job in progress?|\r\n| IsAdhoc| Is the job ad hoc?|\r\n| IsCompleted| Is the job completed?Filterable.|\r\n| CompletedDate| The completed date of the job|\r\n| IsConfirmed| Is the job confirmed?|\r\n| IsExternalTransport| Is the job using external transport?|\r\n| IsFinanciallyConfirmed| Is the job financially confirmed?|\r\n| IsHazardousPaperworkComplete| Is the hazardous paperwork complete?|\r\n| IsScheduledTransfer| Is the job a scheduled transfer?|\r\n| IsWarranty| Is the job a warranty?|\r\n| IsDeleted| Whether to delete the job|\r\n| DeleteReasonGuid| The GUID of delete reason|\r\n| RelatedPONumberGuid| The GUID of related PONumber associated to the job. Filterable.|\r\n| RelatedRouteVisitGuid| The GUID of related routeVisit associated to the job. Filterable.|\r\n| RelatedScheduleGuid| The GUID of related schedule associated to the job. Filterable.|\r\n| RelatedSiteOrderGuid| The GUID of related siteorder associated to the job. Filterable.|\r\n| RelatedSiteOrderItemGuid| The GUID of related siteorder item associated to the job. Filterable.|\r\n| RelatedSupplierSiteTransportGuid| The GUID of related supplier site transport associated to the job. Filterable.|\r\n| RelatedExternalVehicleGuid| The GUID of related external vehicle associated to the job. Filterable.|\r\n| ActionListItem| The GUID and description of the action associated to the job.| \r\n| CancelledReasonListItem| The GUID and description of the cancellation reason associated to the job. |\r\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the job. |\r\n| ContainerTypeListItem| The GUID and description of the container type associated to the job. |\r\n| DepartmentListItem| The GUID and description of the department associated to the job. |\r\n| MaterialListItem| The GUID and description of the material associated to the job. |\r\n| PaymentTypeListItem| The GUID and description of the payment type associated to the job. |\r\n| RepairReasonListItem| The GUID and description of the repair reason associated to the job. |\r\n| Access[]| The array of job access time associated to the job.|\r\n| Access[0].Contact| The contact associated to the job access time.|\r\n| Access[0].StartTime| The start time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\r\n| Access[0].EndTime| The end time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).|\r\n| Access[0].Notes| The notes time associated to the job access time.|\r\n| Access[0].DayOfWeekId | The day of the week associated to the job access time.|\r\n| Access[0].GUID| The Guid associated to the job access time.|\r\n| ContainerDetails| The container details object associated to the job.|\r\n| ContainerDetails.Delivered| The container delivered to the job.|\r\n| ContainerDetails.Delivered.RelatedContainerGuid| The GUID of the container delivered to the job.|\r\n| ContainerDetails.Delivered.ContainerTypeListItem| The GUID and description of the container type delivered to the job.|\r\n| ContainerDetails.Delivered.Notes| The delivered container notes.|\r\n| ContainerDetails.Delivered.SerialNo| The delivered container serial number.|\r\n| ContainerDetails.Delivered.Tag| The delivered container tag.|\r\n| ContainerDetails.Removed| The container removed from the job.|\r\n| ContainerDetails.Removed.RelatedContainerGuid| The GUID of the container removed from the job.|\r\n| ContainerDetails.Removed.ContainerTypeListItem| The GUID and description of the container type removed from to the job.|\r\n| ContainerDetails.Removed.Notes| The removed container notes.|\r\n| ContainerDetails.Removed.SerialNo| The removed container serial number.|\r\n| ContainerDetails.Removed.Tag| The removed container tag.|\r\n| VisitDetails| The visit details object associated to the job.|\r\n| VisitDetails.DriverNotes| The driver notes on the visit associated to the job.|\r\n| VisitDetails.TimeInCustomerSite| The time in on the visit associated to the job.|\r\n| VisitDetails.TimeOutCustomerSite| The time out on the visit associated to the job.|\r\n| VisitDetails.HoursChargable| The hours chargeable on the visit associated to the job.|\r\n| VisitDetails.HoursNotChargable| The hours not chargeable on the visit associated to the job.|\r\n| CustomerOrderNo| The customer order number associated to the job. Filterable.|\r\n| DateRequired| The date the job is required.|\r\n| HazardousLoadReference| The hazardous load reference associated to the job. Filterable.|\r\n| ManualTicketNo| The manual ticket number associated to the job. Filterable. |\r\n| Notes| The notes associated to the job. Filterable.|\r\n| PONumber| The PO number associated to the job.|\r\n| Quantity| The quantity associated to the job.|\r\n| ReleaseNumber| The release number associated to the job.|\r\n| TicketNo| The ticket number associated to the job. Filterable. |\r\n| RejectedReasonListItem| The GUID and description of the job rejection reason. |\r\n| RelatedLocationDestinationGuid| Used to filter the related destination location guid associated to the job. Filterable.|\r\n| RelatedPictureBlobHashes| The array of related blob hashes and descriptions associated to the job.|\r\n| RelatedPictureBlobHashes[0].Description| The description of the blob.|\r\n| RelatedPictureBlobHashes[0].Hash| The hash of the blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\r\n| RelatedPictureBlobHashes[0].PictureSourceListItem| The GUID and description of the Picture Source associated to the job.|\r\n| RelatedPictureBlobHashes[0].PictureTypeListItem| The GUID and description of the Picture Type associated to the job.|\r\n| PriceOverrides| The array of price overrides associated to the job.|\r\n| PriceOverrides[0].RelatedPriceGuid| The GUID of the price associated to the job price override.|\r\n| PriceOverrides[0].OverrideRate| The override rate associated to the job price override.|\r\n| PriceOverrides[0].Guid| The GUID associated to the job price override.|\r\n| PriceOverrides[0].IsSelected| The price isselected associated to the job price override.|\r\n| PriceOverrides[0].Breakdowns| The array of price breakdowns associated to the job price.|\r\n| PriceOverrides[0].Breakdowns[0].Guid| The GUID associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].IsDeleted| Whether the price breakdown is deleted.|\r\n| PriceOverrides[0].Breakdowns[0].FillLevel| The fill level associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].Quantity| The quantity associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].IsReceived| Whether the price breakdown is received.|\r\n| PriceOverrides[0].Breakdowns[0].Barcode| The BarCode associated to the price breakdown.|\r\n| PriceOverrides[0].Breakdowns[0].JobPriceBreakdownTypeEnum| The Job Price Breakdown Type associated to the price breakdown.|\r\n| RelatedPriceGuidFilter| Used to filter on the related price GUID.|\r\n| RelatedBlobJobDocketPdfHashes| The array of related job docket blob hashes.|\r\n| RelatedBlobJobDocketPdfHashes[0].Hash| The hash of the job docket blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\r\n| RelatedWTNBlobHashes| The array of related waste transfer note blob hashes.|\r\n| RelatedWTNBlobHashes[0].Guid| The guid of the job waste transfer note blob.|\r\n| RelatedWTNBlobHashes[0].Hash| The hash of the job waste transfer note blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted.|\r\n| VATIntendedListItem| The GUID and description (code + rate) of the VAT associated to the job.|\r\n| RequiredStartTime| The start time at which the job is required.|\r\n| RequiredEndTime| The end time at which the job is required.|\r\n| ServiceListItem| The GUID and description of the Service associated to the job.|\r\n| LastChangeReasonListItem| The GUID and description of the last change reason associated to the job. |\r\n| LinkedJobs| The array of linked jobs associated to the job.|\r\n| LinkedJobs[0].Guid| The guid of the linked job associated to the job.|\r\n| LinkedJobs[0].IsDeleted| Whether the linked job is deleted.|\r\n| LinkedJobs[0].RelatedJobGuid| The job guid of the linked job associated to the job.|\r\n| Position| The position associated to the job.|\r\n| RelatedCreatedByUserGuid| The created by sys user guid associated to the job. Filterable.|\r\n| LinkedJobGuidFilter| Used to filter on linked job guid.|\r\n| RelatedJobGuidFilter| Used to filer on the job guid of the linked job.|\r\n| MaterialSaleSlots| The array of material sale slots associated to the job.|\r\n| MaterialSaleSlots[0].SlotNumber| The slot number associated to the jobmaterial sale slot.|\r\n| MaterialSaleSlots[0].SlotDate| The slot date associated to the job material sale slot.|\r\n| MaterialSaleSlots[0].SlotTime| The slot time associated to the job material sale slot.|\r\n| MaterialSaleSlots[0].CompanyOutletListItem| The GUID and description of the CompanyOutlet associated to the material sale slot. |\r\n| MaterialSaleSlots[0].MaterialListItem| The GUID and description of the Material associated to the material sale slot.|\r\n| MaterialSaleSlots[0].Notes| The notes associated to the job.|\r\n| MaterialSaleSlots[0].RelatedBookingSlotGuid| The guid of booking slot associated to the material sale slot.|\r\n| MaterialSaleSlots[0].RelatedCustomerGuid| The guid of customer associated to the material sale slot.|\r\n| MaterialSaleSlots[0].IsSchedule| The Schedule of material sale slots associated to the job.|\r\n| MaterialSaleSlots[0].IsManuallyAssigned| The IsManuallyAssigned of material sale slots associated to the job.|\r\n| MaterialSaleSlots[0].IsDeleted| Whether the material sale slot is deleted.|\r\n| MaterialSaleSlots[0].Guid| The GUID associated to the material sale slot.|\r\n| MaterialSaleSlotSlotNumberFilter| Used to filter on the material sale slot slot number.|\r\n| MaterialSaleSlotGuidFilter| Used to filter on the material sale slot guid.|\r\n| MaterialSaleSlotRelatedBookingSlotGuidFilter| Used to filter on the material sale slot related booking slot guid.|\r\n| MaterialSaleSlotRelatedCustomerGuidFilter| Used to filter on the material sale slot related customer guid.|\r\n| PriorityListItem| The GUID and description of the priority associated to the job. |\r\n| DriverFeedback| The driver feedback associated to the job. |"
operationId: Job_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity[ApiIntegratorJobResource]'
put:
tags:
- Job
summary: Partial update
description: "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID | The GUID associated to the job.| Yes |\r\n| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.| Yes |\r\n| InProgress| Is the job in progress?| Yes |\r\n| IsAdhoc| Is the job ad hoc?| Yes |\r\n| IsCompleted| Is the job completed?| Yes |\r\n| CompletedDate| The completed date of the job| No |\r\n| IsConfirmed| Is the job confirmed?| Yes |\r\n| IsExternalTransport| Is the job using external transport?| Yes |\r\n| IsFinanciallyConfirmed| Is the job financially confirmed?| Yes |\r\n| IsHazardousPaperworkComplete| Is the hazardous paperwork complete?| Yes |\r\n| IsScheduledTransfer| Is the job a scheduled transfer?| Yes |\r\n| IsWarranty| Is the job a warranty?| Yes |\r\n| IsDeleted| Whether to delete the job| No |\r\n| DeleteReasonGuid| The GUID of delete reason| No (Required only if IsDeleted=true) |\r\n| RelatedPONumberGuid| The GUID of related PONumber associated to the job. | No |\r\n| RelatedRouteVisitGuid| The GUID of related routeVisit associated to the job. | No |\r\n| RelatedScheduleGuid| The GUID of related schedule associated to the job. Set to null to un-assign the job. | No |\r\n| RelatedSiteOrderGuid| The GUID of related siteorder associated to the job. | Yes (Not required for Transfer out weighingType)|\r\n| RelatedSiteOrderItemGuid| The GUID of related siteorder item associated to the job. | No (Required Only for Container Jobs(Except Start of cycle)) |\r\n| RelatedSupplierSiteTransportGuid| The GUID of related supplier site transport associated to the job. | No |\r\n| RelatedExternalVehicleGuid | The GUID of related external vehicle associated to the job. | No |\r\n| ActionListItem| The GUID and description of the action associated to the job.| Yes |\r\n| CancelledReasonListItem| The GUID and description of the cancellation reason associated to the job. | No |\r\n| CompanyOutletListItem| The GUID and description of the company outlet associated to the job. | Yes |\r\n| ContainerTypeListItem| The GUID and description of the container type associated to the job. | Yes (Only for Container & Collection Jobs) |\r\n| DepartmentListItem| The GUID and description of the department associated to the job. | No |\r\n| MaterialListItem| The GUID and description of the material associated to the job. | Yes (Only for Container & Collection Jobs)|\r\n| PaymentTypeListItem| The GUID and description of the payment type associated to the job. | No |\r\n| RepairReasonListItem| The GUID and description of the repair reason associated to the job. | No |\r\n| Access[]| The array of job access time associated to the job.| No |\r\n| Access[0].Contact| The contact associated to the job access time.| No |\r\n| Access[0].StartTime| The start time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).| Yes |\r\n| Access[0].EndTime| The end time associated to the job access time in ISO format (YYYY-MM-DD HH:mm).| Yes |\r\n| Access[0].Notes| The notes time associated to the job access time.| No |\r\n| Access[0].DayOfWeekId | The day of the week associated to the job access time.| Yes |\r\n| Access[0].GUID| The Guid associated to the job access time.| Yes |\r\n| ContainerDetails| The container details object associated to the job.| No |\r\n| ContainerDetails.Delivered| The container delivered to the job.| No |\r\n| ContainerDetails.Delivered.RelatedContainerGuid | The GUID of the container delivered to the job.| No |\r\n| ContainerDetails.Delivered.ContainerTypeListItem | The GUID and description of the container type delivered to the job. | No |\r\n| ContainerDetails.Delivered.Notes| The delivered container notes.| No |\r\n| ContainerDetails.Delivered.SerialNo| The delivered container serial number.| Yes |\r\n| ContainerDetails.Delivered.Tag| The delivered container tag.| Yes |\r\n| ContainerDetails.Removed| The container removed from the job.| No |\r\n| ContainerDetails.Removed.RelatedContainerGuid| The GUID of the container removed from the job.| No |\r\n| ContainerDetails.Removed.ContainerTypeListItem | The GUID and description of the container type removed from to the job. | No |\r\n| ContainerDetails.Removed.Notes| The removed container notes.| No |\r\n| ContainerDetails.Removed.SerialNo| The removed container serial number.| Yes |\r\n| ContainerDetails.Removed.Tag| The removed container tag.| Yes |\r\n| VisitDetails| The visit details object associated to the job.| No |\r\n| VisitDetails.DriverNotes| The driver notes on the visit associated to the job.| No |\r\n| VisitDetails.TimeInCustomerSite| The time in on the visit associated to the job.| No |\r\n| VisitDetails.TimeOutCustomerSite| The time out on the visit associated to the job.| No |\r\n| VisitDetails.HoursChargeable| The hours chargeable on the visit associated to the job.| No |\r\n| VisitDetails.HoursNotChargeable| The hours not chargeable on the visit associated to the job.| No |\r\n| CustomerOrderNo| The customer order number associated to the job.| No |\r\n| DateRequired| The date the job is required.| Yes |\r\n| HazardousL
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-job-api-openapi.yml