{ "opencollection": "1.0.0", "info": { "name": "Delphix DCT Algorithms Executions API", "version": "3.28.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Executions", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the list of masking executions.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions", "params": [ { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ] }, "docs": "Retrieve the list of masking executions." }, { "info": { "name": "Search masking executions.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/search", "params": [ { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search masking executions." }, { "info": { "name": "Retrieve an Execution by ID.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." } ] }, "docs": "Retrieve an Execution by ID." }, { "info": { "name": "Cancel an Execution.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/:executionId/cancel", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel an Execution." }, { "info": { "name": "Restart an Execution (Hyperscale only).", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/:executionId/restart", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." } ] }, "docs": "Restart an Execution (Hyperscale only)." }, { "info": { "name": "Cleanup an Execution (Hyperscale only).", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/:executionId/cleanup", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." } ] }, "docs": "Cleanup an Execution (Hyperscale only)." }, { "info": { "name": "Retrieve the list of events for a masking execution.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId/events", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ] }, "docs": "Retrieve the list of events for a masking execution." }, { "info": { "name": "Search masking executions events.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/:executionId/events/search", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search masking executions events." }, { "info": { "name": "Retrieve the masking execution log.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId/log", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." } ] }, "docs": "Returns the execution log information for the given execution." }, { "info": { "name": "Get execution components for an execution.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId/execution-components", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ] }, "docs": "Get execution components for an execution." }, { "info": { "name": "Search execution components for an execution.", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/:executionId/execution-components/search", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "id", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search execution components for an execution." }, { "info": { "name": "Get an execution component by ID.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId/execution-components/:executionComponentId", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "executionComponentId", "value": "", "type": "path", "description": "The ID of the Execution Component." } ] }, "docs": "Get an execution component by ID." }, { "info": { "name": "Get an execution component log.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId/execution-components/:executionComponentId/log", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "executionComponentId", "value": "", "type": "path", "description": "The ID of the Execution Component." } ] }, "docs": "Returns the execution component log information for the given execution component." }, { "info": { "name": "Retrieve the list of discovery results for a masking execution.", "type": "http" }, "http": { "method": "GET", "url": "/dct/v3/executions/:executionId/discovery-results", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "column_name", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ] }, "docs": "Retrieve the list of discovery results for a masking execution." }, { "info": { "name": "Search discovery results associated with execution of a discovery job", "type": "http" }, "http": { "method": "POST", "url": "/dct/v3/executions/:executionId/discovery-results/search", "params": [ { "name": "executionId", "value": "", "type": "path", "description": "The ID of the Execution." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints." }, { "name": "sort", "value": "column_name", "type": "query", "description": "The field to sort results by. A property name with a prepended '-' signifies a descending order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search discovery results associated with execution of a discovery job" } ] } ], "bundled": true }