{ "opencollection": "1.0.0", "info": { "name": "Core AccessGroup Job API", "version": "core" }, "items": [ { "info": { "name": "Job", "type": "folder" }, "items": [ { "info": { "name": "GET /jobsystem/jobs/changes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobsystem/jobs/changes", "params": [ { "name": "since", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "links", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /jobsystem/jobs/template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobsystem/jobs/template" } }, { "info": { "name": "GET /jobsystem/jobs/{id}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobsystem/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "links", "value": "", "type": "query" }, { "name": "include", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "udf", "value": "", "type": "query" } ] } }, { "info": { "name": "PUT /jobsystem/jobs/{id}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/jobsystem/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "DELETE /jobsystem/jobs/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/jobsystem/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "GET /jobsystem/jobs/{id}/blob/{blobMemberName}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobsystem/jobs/:id/blob/:blobMemberName", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "blobMemberName", "value": "", "type": "path" }, { "name": "fileName", "value": "", "type": "query" }, { "name": "contentType", "value": "", "type": "query" } ] } }, { "info": { "name": "GET /jobsystem/jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobsystem/jobs", "params": [ { "name": "filter", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "includeCount", "value": "", "type": "query" }, { "name": "includeDeleted", "value": "", "type": "query" }, { "name": "links", "value": "", "type": "query" }, { "name": "udf", "value": "", "type": "query" } ] } }, { "info": { "name": "POST /jobsystem/jobs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobsystem/jobs", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Retrieve changes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/transport/jobs/changes", "params": [ { "name": "since", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "| 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?F" }, { "info": { "name": "Find with GUID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/transport/jobs/:guid", "params": [ { "name": "guid", "value": "", "type": "path" }, { "name": "udf", "value": "", "type": "query" } ] }, "docs": "| 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?F" }, { "info": { "name": "Partial update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/transport/jobs/:guid", "params": [ { "name": "guid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "| 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" }, { "info": { "name": "Find with Filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/transport/jobs", "params": [ { "name": "filter", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "includeCount", "value": "", "type": "query" }, { "name": "udf", "value": "", "type": "query" } ] }, "docs": "| 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?F" }, { "info": { "name": "Create or update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/transport/jobs", "body": { "type": "json", "data": "{}" } }, "docs": "| Property | Description | Required |\r\n| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |\r\n| GUID | The GUID associated to the job.| No |\r\n| DeleteRouteAssignmentsOnCompletion| Whether to delete route assignments on completion of the job.| Yes |\r\n| InProgress| Is the job in progress?| Yes " } ] } ], "bundled": true }