{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Routing API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Routing", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Retrieves Existing Classification Policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/classificationPolicies", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of objects to return per page." } ] }, "docs": "Retrieves existing classification policies." }, { "info": { "name": "Microsoft Azure Retrieves An Existing Classification Policy By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/classificationPolicies/:classificationPolicyId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "classificationPolicyId", "value": "", "type": "path", "description": "Id of a classification policy." } ] }, "docs": "Retrieves an existing classification policy by Id." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Classification Policy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/routing/classificationPolicies/:classificationPolicyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "classificationPolicyId", "value": "", "type": "path", "description": "Id of a classification policy." } ] }, "docs": "Creates or updates a classification policy." }, { "info": { "name": "Microsoft Azure Delete A Classification Policy By Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/routing/classificationPolicies/:classificationPolicyId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "classificationPolicyId", "value": "", "type": "path", "description": "Id of a classification policy." } ] }, "docs": "Delete a classification policy by Id." }, { "info": { "name": "Microsoft Azure Retrieves Existing Distribution Policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/distributionPolicies", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of objects to return per page." } ] }, "docs": "Retrieves existing distribution policies." }, { "info": { "name": "Microsoft Azure Retrieves An Existing Distribution Policy By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/distributionPolicies/:distributionPolicyId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "distributionPolicyId", "value": "", "type": "path", "description": "Id of a distribution policy." } ] }, "docs": "Retrieves an existing distribution policy by Id." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Distribution Policy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/routing/distributionPolicies/:distributionPolicyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "distributionPolicyId", "value": "", "type": "path", "description": "Id of a distribution policy." } ] }, "docs": "Creates or updates a distribution policy." }, { "info": { "name": "Microsoft Azure Delete A Distribution Policy By Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/routing/distributionPolicies/:distributionPolicyId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "distributionPolicyId", "value": "", "type": "path", "description": "Id of a distribution policy." } ] }, "docs": "Delete a distribution policy by Id." }, { "info": { "name": "Microsoft Azure Retrieves Existing Exception Policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/exceptionPolicies", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of objects to return per page." } ] }, "docs": "Retrieves existing exception policies." }, { "info": { "name": "Microsoft Azure Retrieves An Existing Exception Policy By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/exceptionPolicies/:exceptionPolicyId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "exceptionPolicyId", "value": "", "type": "path", "description": "Id of an exception policy." } ] }, "docs": "Retrieves an existing exception policy by Id." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Exception Policy", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/routing/exceptionPolicies/:exceptionPolicyId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "exceptionPolicyId", "value": "", "type": "path", "description": "Id of an exception policy." } ] }, "docs": "Creates or updates a exception policy." }, { "info": { "name": "Microsoft Azure Deletes A Exception Policy By Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/routing/exceptionPolicies/:exceptionPolicyId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "exceptionPolicyId", "value": "", "type": "path", "description": "Id of an exception policy." } ] }, "docs": "Deletes a exception policy by Id." }, { "info": { "name": "Microsoft Azure Retrieves List Of Jobs Based On Filter Parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/jobs", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of objects to return per page." }, { "name": "status", "value": "", "type": "query", "description": "If specified, filter jobs by status." }, { "name": "queueId", "value": "", "type": "query", "description": "If specified, filter jobs by queue." }, { "name": "channelId", "value": "", "type": "query", "description": "If specified, filter jobs by channel." }, { "name": "classificationPolicyId", "value": "", "type": "query", "description": "If specified, filter jobs by classificationPolicy." }, { "name": "scheduledBefore", "value": "", "type": "query", "description": "If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore]." }, { "name": "scheduledAfter", "value": "", "type": "query", "description": "If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf)." } ] }, "docs": "Retrieves list of jobs based on filter parameters." }, { "info": { "name": "Microsoft Azure Retrieves An Existing Job By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/jobs/:jobId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." } ] }, "docs": "Retrieves an existing job by Id." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Router Job", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/routing/jobs/:jobId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." } ] }, "docs": "Creates or updates a router job." }, { "info": { "name": "Microsoft Azure Deletes A Job And All Of Its Traces", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/routing/jobs/:jobId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." } ] }, "docs": "Deletes a job and all of its traces." }, { "info": { "name": "Microsoft Azure Reclassify A Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/jobs/:jobId:reclassify", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." } ] }, "docs": "Reclassify a job." }, { "info": { "name": "Microsoft Azure Submits Request To Cancel An Existing Job By Id While Supplying Free Form Cancellation Reason", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/jobs/:jobId:cancel", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." } ] }, "docs": "Submits request to cancel an existing job by Id while supplying free-form cancellation reason." }, { "info": { "name": "Microsoft Azure Completes An Assigned Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/jobs/:jobId/assignments/:assignmentId:complete", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." }, { "name": "assignmentId", "value": "", "type": "path", "description": "Id of a job assignment." } ] }, "docs": "Completes an assigned job." }, { "info": { "name": "Microsoft Azure Closes A Completed Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/jobs/:jobId/assignments/:assignmentId:close", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." }, { "name": "assignmentId", "value": "", "type": "path", "description": "Id of a job assignment." } ] }, "docs": "Closes a completed job." }, { "info": { "name": "Microsoft Azure Unassign A Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/jobs/:jobId/assignments/:assignmentId:unassign", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of a job." }, { "name": "assignmentId", "value": "", "type": "path", "description": "Id of a job assignment." } ] }, "docs": "Unassign a job." }, { "info": { "name": "Microsoft Azure Gets A Job S Position Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/jobs/:jobId/position", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "jobId", "value": "", "type": "path", "description": "Id of the job." } ] }, "docs": "Gets a job's position details." }, { "info": { "name": "Microsoft Azure Retrieves Existing Queues", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/queues", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of objects to return per page." } ] }, "docs": "Retrieves existing queues." }, { "info": { "name": "Microsoft Azure Retrieves An Existing Queue By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/queues/:queueId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "queueId", "value": "", "type": "path", "description": "Id of a queue." } ] }, "docs": "Retrieves an existing queue by Id." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Queue", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/routing/queues/:queueId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "queueId", "value": "", "type": "path", "description": "Id of a queue." } ] }, "docs": "Creates or updates a queue." }, { "info": { "name": "Microsoft Azure Deletes A Queue By Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/routing/queues/:queueId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "queueId", "value": "", "type": "path", "description": "Id of a queue." } ] }, "docs": "Deletes a queue by Id." }, { "info": { "name": "Microsoft Azure Retrieves A Queue S Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/queues/:queueId/statistics", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "queueId", "value": "", "type": "path", "description": "Id of the queue to retrieve statistics." } ] }, "docs": "Retrieves a queue's statistics." }, { "info": { "name": "Microsoft Azure Retrieves Existing Workers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/workers", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "Number of objects to return per page." }, { "name": "state", "value": "", "type": "query", "description": "If specified, select workers by worker state." }, { "name": "channelId", "value": "", "type": "query", "description": "If specified, select workers who have a channel configuration with this channel." }, { "name": "queueId", "value": "", "type": "query", "description": "If specified, select workers who are assigned to this queue." }, { "name": "hasCapacity", "value": "", "type": "query", "description": "If set to true, select only workers who have capacity for the channel specified by `channelId` or for any channel if `channelId` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false." } ] }, "docs": "Retrieves existing workers." }, { "info": { "name": "Microsoft Azure Retrieves An Existing Worker By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/routing/workers/:workerId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "workerId", "value": "", "type": "path", "description": "Id of a worker." } ] }, "docs": "Retrieves an existing worker by Id." }, { "info": { "name": "Microsoft Azure Creates Or Updates A Worker", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/routing/workers/:workerId", "headers": [ { "name": "If-Match", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "workerId", "value": "", "type": "path", "description": "Id of a worker." } ] }, "docs": "Creates or updates a worker." }, { "info": { "name": "Microsoft Azure Deletes A Worker And All Of Its Traces", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/routing/workers/:workerId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "workerId", "value": "", "type": "path", "description": "Id of a worker." } ] }, "docs": "Deletes a worker and all of its traces." }, { "info": { "name": "Microsoft Azure Accepts An Offer To Work On A Job And Returns A 409 Conflict If Another Agent Accepted The Job Already", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/workers/:workerId/offers/:offerId:accept", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "workerId", "value": "", "type": "path", "description": "Id of a worker." }, { "name": "offerId", "value": "", "type": "path", "description": "Id of an offer." } ] }, "docs": "Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already." }, { "info": { "name": "Microsoft Azure Declines An Offer To Work On A Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/routing/workers/:workerId/offers/:offerId:decline", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "workerId", "value": "", "type": "path", "description": "Id of a worker." }, { "name": "offerId", "value": "", "type": "path", "description": "Id of an offer." } ] }, "docs": "Declines an offer to work on a job." } ] } ], "bundled": true }