{ "opencollection": "1.0.0", "info": { "name": "Oracle Cloud Migrations Migration API", "version": "20220919" }, "items": [ { "info": { "name": "migration", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all migration assets for migration.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationAssets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "query", "description": "Unique migration identifier" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire given display name." }, { "name": "migrationAssetId", "value": "", "type": "query", "description": "Unique migration asset identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the migration asset." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.\n" } ] }, "docs": "Returns a list of migration assets.\n" }, { "info": { "name": "Creates a migration asset.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationAssets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a migration asset.\n" }, { "info": { "name": "Gets a migration asset.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationAssets/:migrationAssetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationAssetId", "value": "", "type": "path", "description": "Unique migration asset identifier" } ] }, "docs": "Gets a migration asset by identifier." }, { "info": { "name": "Updates the migration asset identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220919/migrationAssets/:migrationAssetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationAssetId", "value": "", "type": "path", "description": "Unique migration asset identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the migration asset." }, { "info": { "name": "Deletes a provisioned migration asset.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220919/migrationAssets/:migrationAssetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationAssetId", "value": "", "type": "path", "description": "Unique migration asset identifier" } ] }, "docs": "Deletes a migration asset resource by an identifier." }, { "info": { "name": "Refreshes asset with inventory.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationAssets/:migrationAssetId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationAssetId", "value": "", "type": "path", "description": "Unique migration asset identifier" } ] }, "docs": "Refreshes the migration asset with the migration asset ID.\n" }, { "info": { "name": "Gets the progress percentage of the migration asset's replication process.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationAssets/:migrationAssetId/actions/replicationProgress", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationAssetId", "value": "", "type": "path", "description": "Unique migration asset identifier" } ] }, "docs": "Gets the progress percentage of a migration asset's replication process.\n" }, { "info": { "name": "Starts a replication for the asset.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationAssets/:migrationAssetId/actions/startAssetReplication", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationAssetId", "value": "", "type": "path", "description": "Unique migration asset identifier" } ] }, "docs": "Starts replication for the asset with the migration asset ID.\n" }, { "info": { "name": "Gets a list of all migration plans in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationPlans", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "migrationId", "value": "", "type": "query", "description": "Unique migration identifier" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire given display name." }, { "name": "migrationPlanId", "value": "", "type": "query", "description": "Unique migration plan identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the migration plan." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.\n" } ] }, "docs": "Returns a list of migration plans.\n" }, { "info": { "name": "Creates a migration plan.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationPlans", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a migration plan.\n" }, { "info": { "name": "Gets a migration plan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ] }, "docs": "Gets a migration plan by identifier." }, { "info": { "name": "Updates the migration plan identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the migration plan." }, { "info": { "name": "Delete a provisioned migration plan.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ] }, "docs": "Deletes a migration plan resource by an identifier." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Executes the migration plan to create an RMS stack.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId/actions/execute", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ] }, "docs": "Executes the migration plan with the migration plan ID.\n" }, { "info": { "name": "Exports the migration plan to a csv file.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId/actions/export", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ] }, "docs": "Exports the migration plan to a csv file." }, { "info": { "name": "Imports a migration plan from a csv file.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId/actions/import", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ] }, "docs": "Imports a migration plan from a csv file." }, { "info": { "name": "Refreshes the migration plan with inventory.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" } ] }, "docs": "Refreshes the migration plan with the migration plan ID.\n" }, { "info": { "name": "List of available shapes.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrationPlans/:migrationPlanId/availableShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "dvhHostId", "value": "", "type": "query", "description": "The ID of the Dvh in which to list resources." }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The availability domain in which to list resources." }, { "name": "reservedCapacityId", "value": "", "type": "query", "description": "The reserved capacity ID for which to list resources." }, { "name": "migrationPlanId", "value": "", "type": "path", "description": "Unique migration plan identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.\n" } ] }, "docs": "List of shapes by parameters." }, { "info": { "name": "Gets a list of all migrations in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources where the resource's lifecycle state matches the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire given display name." }, { "name": "migrationId", "value": "", "type": "query", "description": "Unique migration identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.\n" } ] }, "docs": "Returns a list of migrations.\n" }, { "info": { "name": "Creates a migration.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a migration.\n" }, { "info": { "name": "Gets a migration", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/migrations/:migrationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "Unique migration identifier" } ] }, "docs": "Gets a migration by identifier." }, { "info": { "name": "Updates the migration identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220919/migrations/:migrationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "Unique migration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the migration." }, { "info": { "name": "Deletes a provisioned migration.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220919/migrations/:migrationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "Unique migration identifier" } ] }, "docs": "Deletes a migration resource by identifier." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrations/:migrationId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "Unique migration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Refreshes migration", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrations/:migrationId/actions/refresh", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "Unique migration identifier" } ] }, "docs": "Refreshes migration based on the migration ID.\n" }, { "info": { "name": "Starts replication for the migration", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/migrations/:migrationId/actions/startMigrationReplication", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "migrationId", "value": "", "type": "path", "description": "Unique migration identifier" } ] }, "docs": "Starts replication for a migration or for some asset.\n" }, { "info": { "name": "Gets a list of all replication schedules in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/replicationSchedules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the replication schedule." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire given display name." }, { "name": "replicationScheduleId", "value": "", "type": "query", "description": "Unique replication schedule identifier in query" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.\n" } ] }, "docs": "Returns a list of replication schedules.\n" }, { "info": { "name": "Creates a replication schedule.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/replicationSchedules", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a replication schedule.\n" }, { "info": { "name": "Gets a replication schedule.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/replicationSchedules/:replicationScheduleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationScheduleId", "value": "", "type": "path", "description": "Unique replication schedule identifier in path" } ] }, "docs": "Gets a replication schedule by identifier." }, { "info": { "name": "Updates the replication schedule identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220919/replicationSchedules/:replicationScheduleId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationScheduleId", "value": "", "type": "path", "description": "Unique replication schedule identifier in path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the replication schedule." }, { "info": { "name": "Deletes a provisioned replication schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220919/replicationSchedules/:replicationScheduleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationScheduleId", "value": "", "type": "path", "description": "Unique replication schedule identifier in path" } ] }, "docs": "Deletes a replication schedule resource by identifier." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/replicationSchedules/:replicationScheduleId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "replicationScheduleId", "value": "", "type": "path", "description": "Unique replication schedule identifier in path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of all target assets for migration plan.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/targetAssets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "migrationPlanId", "value": "", "type": "query", "description": "Unique migration plan identifier" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire given display name." }, { "name": "targetAssetId", "value": "", "type": "query", "description": "Unique target asset identifier" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the target asset." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending.\n" } ] }, "docs": "Returns a list of target assets.\n" }, { "info": { "name": "Creates a target asset.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220919/targetAssets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a target asset.\n" }, { "info": { "name": "Gets a target asset.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/targetAssets/:targetAssetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAssetId", "value": "", "type": "path", "description": "Unique target asset identifier" } ] }, "docs": "Gets a target asset by identifier." }, { "info": { "name": "Updates the target asset identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220919/targetAssets/:targetAssetId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAssetId", "value": "", "type": "path", "description": "Unique target asset identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the target asset." }, { "info": { "name": "Deletes a provisioned target asset.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220919/targetAssets/:targetAssetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "targetAssetId", "value": "", "type": "path", "description": "Unique target asset identifier" } ] }, "docs": "Deletes a target asset resource by identifier." }, { "info": { "name": "List of work requests.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources where the resource's lifecycle state matches the given operation status." }, { "name": "operationType", "value": "", "type": "query", "description": "A filter to return only resources where the resource's lifecycle state matches the given operation type." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for 'timeAccepted' is descending.\n" } ] }, "docs": "List of work requests in a compartment.\n" }, { "info": { "name": "Gets the work request status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Cancels the work request.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220919/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Cancels work request with the given ID." }, { "info": { "name": "List of work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for 'timeAccepted' is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a paginated list of errors for a given work request.\n" }, { "info": { "name": "List of work request logs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220919/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for 'timeAccepted' is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a paginated list of logs for a given work request.\n" } ] } ], "bundled": true }