{
"opencollection": "1.0.0",
"info": {
"name": "Data Integration API",
"version": "20200430"
},
"items": [
{
"info": {
"name": "DataIntegration",
"type": "folder"
},
"items": [
{
"info": {
"name": "Use this endpoint to list work requests.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The OCID of the compartment containing the resources you want to list."
},
{
"name": "workspaceId",
"value": "",
"type": "query",
"description": "DIS workspace id"
},
{
"name": "workRequestStatus",
"value": "",
"type": "query",
"description": "The work request status."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Lists the work requests in a compartment.\n"
},
{
"info": {
"name": "Use this endpoint to get work request status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workRequests/:workRequestId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The ID of the asynchronous work request to retrieve."
}
]
},
"docs": "Retrieves the status of the work request with the given ID."
},
{
"info": {
"name": "Use this endpoint to list work request logs.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workRequests/:workRequestId/logs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The ID of the asynchronous work request to retrieve."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a paginated list of logs for a given work request.\n"
},
{
"info": {
"name": "Use this endpoint to list work request errors.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workRequests/:workRequestId/workRequestErrors",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workRequestId",
"value": "",
"type": "path",
"description": "The ID of the asynchronous work request to retrieve."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a paginated list of errors for a given work request.\n"
},
{
"info": {
"name": "Use this endpoint to get a list of all Data Integration workspaces in a compartment.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "The OCID of the compartment containing the resources you want to list."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "lifecycleState",
"value": "",
"type": "query",
"description": "The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of Data Integration workspaces.\n"
},
{
"info": {
"name": "Use this endpoint to create a new Data Integration workspace.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the [GetWorkRequest](#/en/data-integration/latest/WorkRequest/GetWorkRequest) API.\n"
},
{
"info": {
"name": "Use this endpoint to get a specified workspace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Retrieves a Data Integration workspace using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the Data Integration workspace identified by the ID.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the specified Data Integration workspace."
},
{
"info": {
"name": "Use this endpoint to delete a provisioned Data Integration workspace.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "quiesceTimeout",
"value": "",
"type": "query",
"description": "Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace."
},
{
"name": "isForceOperation",
"value": "",
"type": "query",
"description": "Used to force close down the workspace."
}
]
},
"docs": "Deletes a Data Integration workspace resource using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to move a workspace to reside in a specified compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a workspace to a specified compartment.\n"
},
{
"info": {
"name": "Use this endpoint to start the workspace.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/actions/start",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Starts a workspace.\n"
},
{
"info": {
"name": "Use this endpoint to stop a workspace.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/actions/stop",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "quiesceTimeout",
"value": "",
"type": "query",
"description": "Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace."
},
{
"name": "isForceOperation",
"value": "",
"type": "query",
"description": "Used to force close down the workspace."
}
]
},
"docs": "Stops a workspace.\n"
},
{
"info": {
"name": "Use this endpoint to lists applications with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the published object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of applications and provides options to filter the list."
},
{
"info": {
"name": "Use this endpoint to create an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an application.\n"
},
{
"info": {
"name": "Use this endpoint to get an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
]
},
"docs": "Retrieves an application using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update an application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an application."
},
{
"info": {
"name": "Use this endpoint to delete an application.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
]
},
"docs": "Removes an application using the specified identifier."
},
{
"info": {
"name": "Get Composite State for a given aggregator",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/compositeState",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "aggregatorKey",
"value": "",
"type": "query",
"description": "Unique key of the aggregator for which we want to get the Composite State"
}
]
},
"docs": "This endpoint can be used to get composite state for a given aggregator\n"
},
{
"info": {
"name": "Use this endpoint to list all dependent objects.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/dependentObjects",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the published object.\n"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Used to filter by the object type of the object.\nIt can be suffixed with an optional filter operator InSubtree.\nFor Data Integration APIs, a filter based on type Task is used.\n"
},
{
"name": "typeInSubtree",
"value": "",
"type": "query",
"description": "Used in association with type parameter. If value is true,\nthen type all sub types of the given type parameter is considered.\nIf value is false, then sub types are not considered. Default is false.\n"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of all dependent objects for a specific application."
},
{
"info": {
"name": "Use this endpoint to get the details of a dependent object.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/dependentObjects/:dependentObjectKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "dependentObjectKey",
"value": "",
"type": "path",
"description": "The dependent object key."
}
]
},
"docs": "Retrieves the details of a dependent object from an application."
},
{
"info": {
"name": "Use this endpoint to get the detailed description of an Application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/detailedDescription",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
]
},
"docs": "Retrieves detailed description of an Application"
},
{
"info": {
"name": "Use this endpoint to create detailed description for an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/detailedDescription",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates detailed description for an application."
},
{
"info": {
"name": "Use this endpoint to change the detailed description of an Application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/detailedDescription",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the detailed description of an Application."
},
{
"info": {
"name": "Use this endpoint to delete detailed description of an Application.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/detailedDescription",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
]
},
"docs": "Deletes detailed description of an Application."
},
{
"info": {
"name": "Use this endpoint to list changes made in the application by patches.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/patchChanges",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "sincePatch",
"value": "",
"type": "query",
"description": "Specifies the patch key to query from."
},
{
"name": "toPatch",
"value": "",
"type": "query",
"description": "Specifies the patch key to query to."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of patches in an application and provides options to filter the list."
},
{
"info": {
"name": "Use this endpoint to list patches with filtering options. For listing changes based on a period and logical objects changed, see ListPatchChanges API.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/patches",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the published object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of patches in an application and provides options to filter the list. For listing changes based on a period and logical objects changed, see ListPatchChanges API."
},
{
"info": {
"name": "Use this endpoint to create a patch in an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/patches",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a patch in an application."
},
{
"info": {
"name": "Use this endpoint to get a patch in an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/patches/:patchKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "patchKey",
"value": "",
"type": "path",
"description": "The patch key."
}
]
},
"docs": "Retrieves a patch in an application using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to delete a patch.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/patches/:patchKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "patchKey",
"value": "",
"type": "path",
"description": "The patch key."
}
]
},
"docs": "Removes a patch using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list the all published objects.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/publishedObjects",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameStartsWith",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names starting with the given value."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the published object.\n"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Used to filter by the object type of the object.\nIt can be suffixed with an optional filter operator InSubtree.\nFor Data Integration APIs, a filter based on type Task is used.\n"
},
{
"name": "typeInSubtree",
"value": "",
"type": "query",
"description": "Used in association with type parameter. If value is true,\nthen type all sub types of the given type parameter is considered.\nIf value is false, then sub types are not considered. Default is false.\n"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of all the published objects for a specified application. Use the fields query parameter with value 'metadata' to retrieve minimal information."
},
{
"info": {
"name": "Use this endpoint to get details of a published object.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/publishedObjects/:publishedObjectKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "publishedObjectKey",
"value": "",
"type": "path",
"description": "The published object key."
},
{
"name": "expandReferences",
"value": "",
"type": "query",
"description": "Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
Example:
- ?expandReferences=true returns all objects of type data loader task
"
}
]
},
"docs": "Retrieves the details of a published object from an application."
},
{
"info": {
"name": "Use this endpoint to get a list of references for an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections. This endpoint returns a set of the references used in the application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/references",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of references in an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections."
},
{
"info": {
"name": "Use this endpoint to get a reference for an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/references/:referenceKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "referenceKey",
"value": "",
"type": "path",
"description": "The reference key."
}
]
},
"docs": "Retrieves a reference in an application."
},
{
"info": {
"name": "Use this endpoint to update application references. For example, to map a data asset to a different target object.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/references/:referenceKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "referenceKey",
"value": "",
"type": "path",
"description": "The reference key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the application references. For example, to map a data asset to a different target object."
},
{
"info": {
"name": "Lists Runtime Pipelines with filtering options",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/runtimePipelines",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "aggregatorKey",
"value": "",
"type": "query",
"description": "Unique key of the aggregator"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "aggregatorType",
"value": "",
"type": "query",
"description": "Unique type of the aggregator"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "This filter parameter can be used to filter by model specific queryable fields of the object
Examples:-
- ?filter=status eq Failed returns all objects that have a status field with value Failed
"
}
]
},
"docs": "This endpoint can be used to list runtime pipelines with filtering options\n"
},
{
"info": {
"name": "Use this endpoint to get a runtime pipeline using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/runtimePipelines/:runtimePipelineKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "runtimePipelineKey",
"value": "",
"type": "path",
"description": "Runtime Pipeline Key"
},
{
"name": "expandReferences",
"value": "",
"type": "query",
"description": "Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
Example:
- ?expandReferences=true returns all objects of type data loader task
"
}
]
},
"docs": "Retrieves a runtime pipeline using the specified identifier."
},
{
"info": {
"name": "Lists Runtime Operators with filtering options",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/runtimePipelines/:runtimePipelineKey/runtimeOperators",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "runtimePipelineKey",
"value": "",
"type": "path",
"description": "Runtime Pipeline Key"
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "aggregatorType",
"value": "",
"type": "query",
"description": "Unique type of the aggregator"
}
]
},
"docs": "This endpoint can be used to list runtime operators with filtering options\n"
},
{
"info": {
"name": "Use this endpoint to get a runtime operator using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/runtimePipelines/:runtimePipelineKey/runtimeOperators/:runtimeOperatorKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "runtimePipelineKey",
"value": "",
"type": "path",
"description": "Runtime Pipeline Key"
},
{
"name": "runtimeOperatorKey",
"value": "",
"type": "path",
"description": "Runtime Operator Key"
}
]
},
"docs": "Retrieves a runtime operator using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a list of schedules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/schedules",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
Examples:
- ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
- ?type=DATA_LOADER_TASK returns all objects of type data loader task
- ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "This filter parameter can be used to filter by name field of the Schedule object
Examples:-
- ?filter=frequencyDetails eq HOURLY returns all Schedule objects with frequency HOURLY
- ?filter=frequencyDetails eq HOURLY&frequencyDetails eq DAILY returns all Schedule objects that have a hourly and monthly frequency
"
}
]
},
"docs": "Use this endpoint to list schedules.\n"
},
{
"info": {
"name": "Use this endpoint to create a new schedule object.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/schedules",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Endpoint to create a new schedule"
},
{
"info": {
"name": "Use this endpoint to get a schedule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/schedules/:scheduleKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "scheduleKey",
"value": "",
"type": "path",
"description": "Schedule Key"
}
]
},
"docs": "Retrieves schedule by schedule key"
},
{
"info": {
"name": "Use this endpoint to update the schedule object identified by the key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/schedules/:scheduleKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "scheduleKey",
"value": "",
"type": "path",
"description": "Schedule Key"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Endpoint used to update the schedule"
},
{
"info": {
"name": "Use this endpoint to delete a schedule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/schedules/:scheduleKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "scheduleKey",
"value": "",
"type": "path",
"description": "Schedule Key"
}
]
},
"docs": "Endpoint to delete schedule."
},
{
"info": {
"name": "Lists Task Run Lineages with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRunLineages",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "This filter parameter can be used to filter by model specific queryable fields of the object
Examples:-
- ?filter=status eq Failed returns all objects that have a status field with value Failed
"
},
{
"name": "timeUpdatedGreaterThan",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
},
{
"name": "timeUpdatedGreaterThanOrEqualTo",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
},
{
"name": "timeUpatedLessThan",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
},
{
"name": "timeUpatedLessThanOrEqualTo",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
}
]
},
"docs": "This endpoint can be used to list Task Run Lineages within a given time window.\n"
},
{
"info": {
"name": "Use this endpoint to lists task runs with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRuns",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "aggregatorKey",
"value": "",
"type": "query",
"description": "Used to filter by the project or the folder object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "This filter parameter can be used to filter by model specific queryable fields of the object
Examples:-
- ?filter=status eq Failed returns all objects that have a status field with value Failed
"
},
{
"name": "nameStartsWith",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names starting with the given value."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
}
]
},
"docs": "Retrieves a list of task runs and provides options to filter the list."
},
{
"info": {
"name": "Use this endpoint to create a Data Integration task run for the specified task.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRuns",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a data integration task run for the specified task."
},
{
"info": {
"name": "Use this endpoint to get a task run using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRuns/:taskRunKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskRunKey",
"value": "",
"type": "path",
"description": "The task run key."
}
]
},
"docs": "Retrieves a task run using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to change the status of the task run. For example, to abort the task run.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRuns/:taskRunKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskRunKey",
"value": "",
"type": "path",
"description": "The task run key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the status of the task run. For example, aborts a task run."
},
{
"info": {
"name": "Use this endpoint to delete a task run.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRuns/:taskRunKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskRunKey",
"value": "",
"type": "path",
"description": "The task run key."
}
]
},
"docs": "Deletes a task run using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list task run logs.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskRuns/:taskRunKey/logs",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskRunKey",
"value": "",
"type": "path",
"description": "The task run key."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Gets log entries for task runs using its key."
},
{
"info": {
"name": "Use this endpoint to get a list of task schedules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskSchedules",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
Examples:
- ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
- ?type=DATA_LOADER_TASK returns all objects of type data loader task
- ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "isEnabled",
"value": "",
"type": "query",
"description": "This filter parameter can be used to filter task schedule by its state."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "This endpoint can be used to get the list of all the TaskSchedule objects.\n"
},
{
"info": {
"name": "Use this endpoint to create a new task schedule object.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskSchedules",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Endpoint to be used create TaskSchedule."
},
{
"info": {
"name": "Use this endpoint to fetch a task Schedule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskSchedules/:taskScheduleKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskScheduleKey",
"value": "",
"type": "path",
"description": "TaskSchedule Key"
}
]
},
"docs": "Endpoint used to get taskSchedule by its key"
},
{
"info": {
"name": "Use this endpoint to update the task schedule object identified by the key",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskSchedules/:taskScheduleKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskScheduleKey",
"value": "",
"type": "path",
"description": "TaskSchedule Key"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Endpoint used to update the TaskSchedule"
},
{
"info": {
"name": "Use this endpoint to delete a task schedule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/applications/:applicationKey/taskSchedules/:taskScheduleKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
},
{
"name": "taskScheduleKey",
"value": "",
"type": "path",
"description": "TaskSchedule Key"
}
]
},
"docs": "Endpoint to delete TaskSchedule."
},
{
"info": {
"name": "Use this endpoint to get a list of connection validations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connectionValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
}
]
},
"docs": "Retrieves a list of connection validations within the specified workspace."
},
{
"info": {
"name": "Use this endpoint to create a connection validation object.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connectionValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Creates a connection validation."
},
{
"info": {
"name": "Use this endpoint to get the connection validation based on its ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connectionValidations/:connectionValidationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionValidationKey",
"value": "",
"type": "path",
"description": "The key of the connection validation."
}
]
},
"docs": "Retrieves a connection validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to delete a connection validation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connectionValidations/:connectionValidationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionValidationKey",
"value": "",
"type": "path",
"description": "The key of the connection validation."
}
]
},
"docs": "Deletes a connection validation."
},
{
"info": {
"name": "Use this endpoint to get a summary of connections.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataAssetKey",
"value": "",
"type": "query",
"description": "Used to filter by the data asset key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of the object to filter the results with."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of all connections."
},
{
"info": {
"name": "Use this endpoint to create a connection under an existing data asset.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Creates a connection under an existing data asset."
},
{
"info": {
"name": "Use this endpoint to get the connection details using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
}
]
},
"docs": "Retrieves the connection details using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update a connection under a data asset.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
}
]
},
"docs": "Updates a connection under a data asset."
},
{
"info": {
"name": "Use this endpoint to delete the connection by given connection id.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
}
]
},
"docs": "Removes a connection using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a summary of schemas using the specified connection.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey/schemas",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "schemaResourceName",
"value": "",
"type": "query",
"description": "Schema resource name used for retrieving schemas."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameList",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "includeTypes",
"value": "",
"type": "query",
"description": "Artifact type which needs to be listed while listing Artifacts."
}
]
},
"docs": "Retrieves a list of all the schemas that can be accessed using the specified connection."
},
{
"info": {
"name": "Use this endpoint to get a schema with the given schema resource name.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey/schemas/:schemaResourceName",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
},
{
"name": "schemaResourceName",
"value": "",
"type": "path",
"description": "The schema resource name used for retrieving schemas."
}
]
},
"docs": "Retrieves a schema that can be accessed using the specified connection."
},
{
"info": {
"name": "Use this endpoint to list the summaries of data entities within the specified schema.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey/schemas/:schemaResourceName/dataEntities",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
},
{
"name": "schemaResourceName",
"value": "",
"type": "path",
"description": "The schema resource name used for retrieving schemas."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of the object to filter the results with."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "nameList",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "isPattern",
"value": "",
"type": "query",
"description": "This parameter can be used to specify whether entity search type is pattern search or not."
},
{
"name": "includeTypes",
"value": "",
"type": "query",
"description": "Artifact type which needs to be listed while listing Artifacts."
}
]
},
"docs": "Lists a summary of data entities from the data asset using the specified connection. \n"
},
{
"info": {
"name": "Use this endpoint to get the data entity from live schema.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey/schemas/:schemaResourceName/dataEntities/:dataEntityKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
},
{
"name": "schemaResourceName",
"value": "",
"type": "path",
"description": "The schema resource name used for retrieving schemas."
},
{
"name": "dataEntityKey",
"value": "",
"type": "path",
"description": "The key of the data entity."
}
]
},
"docs": "Retrieves the data entity details with the given name from live schema."
},
{
"info": {
"name": "Use this endpoint to create a data entity shape using the shape from the data asset.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/connections/:connectionKey/schemas/:schemaResourceName/entityShapes",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "connectionKey",
"value": "",
"type": "path",
"description": "The connection key."
},
{
"name": "schemaResourceName",
"value": "",
"type": "path",
"description": "The schema resource name used for retrieving schemas."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates the data entity shape using the shape from the data asset."
},
{
"info": {
"name": "List copy object requests.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/copyObjectRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "copyStatus",
"value": "",
"type": "query",
"description": "Specifies copy status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED ."
},
{
"name": "projection",
"value": "",
"type": "query",
"description": "This parameter allows users to specify which view of the copy object response to return. SUMMARY - Summary of the copy object response will be returned. This is the default option when no value is specified. DETAILS - Details of copy object response will be returned. This will include details of all the objects to be copied."
},
{
"name": "timeStartedInMillis",
"value": "",
"type": "query",
"description": "Specifies start time of a copy object request."
},
{
"name": "timeEndedInMillis",
"value": "",
"type": "query",
"description": "Specifies end time of a copy object request."
}
]
},
"docs": "This endpoint can be used to get the list of copy object requests.\n"
},
{
"info": {
"name": "Use this endpoint to copy object from one workspace to same/another workspace.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/copyObjectRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Copy Metadata Object.\n"
},
{
"info": {
"name": "Get copy object request summary/details by key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/copyObjectRequests/:copyObjectRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "copyObjectRequestKey",
"value": "",
"type": "path",
"description": "The key of the object to be copied, for example this could be the key of a project."
}
]
},
"docs": "This endpoint can be used to get the summary/details of object being copied.\n"
},
{
"info": {
"name": "Use this endpoint to change the status of a copy object request. For example, cancel a copy object request.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/copyObjectRequests/:copyObjectRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "copyObjectRequestKey",
"value": "",
"type": "path",
"description": "The key of the object to be copied, for example this could be the key of a project."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the status of a copy object request."
},
{
"info": {
"name": "Use this endpoint to delete copy object request.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/copyObjectRequests/:copyObjectRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "copyObjectRequestKey",
"value": "",
"type": "path",
"description": "The key of the object to be copied, for example this could be the key of a project."
}
]
},
"docs": "Delete copy object request using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list statistics on the workspace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/countStatistics/:countStatisticKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "countStatisticKey",
"value": "",
"type": "path",
"description": "A unique key of the container object, such as workspace, project, and so on, to count statistics for. The statistics is fetched for the given key."
}
]
},
"docs": "Retrieves statistics on a workspace. It returns an object with an array of property values, such as the number of projects, |\n applications, data assets, and so on.\n"
},
{
"info": {
"name": "Use this endpoint to get all the data asset summaries. Result can be filtered based on type of data asset by passing type query parameter.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataAssets",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of the object to filter the results with."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of all data asset summaries.\n"
},
{
"info": {
"name": "Use this endpoint to create a data asset with default connection.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataAssets",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Creates a data asset with default connection."
},
{
"info": {
"name": "Use this endpoint to get details of a data asset based on data asset key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataAssets/:dataAssetKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataAssetKey",
"value": "",
"type": "path",
"description": "The data asset key."
}
]
},
"docs": "Retrieves details of a data asset using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update a data asset with default connection.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataAssets/:dataAssetKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataAssetKey",
"value": "",
"type": "path",
"description": "The data asset key."
}
]
},
"docs": "Updates a specific data asset with default connection."
},
{
"info": {
"name": "Use this endpoint to delete a data asset by key.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataAssets/:dataAssetKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataAssetKey",
"value": "",
"type": "path",
"description": "The data asset key."
}
]
},
"docs": "Removes a data asset using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a list of data flow validations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlowValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
}
]
},
"docs": "Retrieves a list of data flow validations within the specified workspace."
},
{
"info": {
"name": "Use this endpoint to execute a data flow validation.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlowValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts the data flow definition in the request payload and creates a data flow validation.\n"
},
{
"info": {
"name": "Use this endpoint to gets a data flow validation using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlowValidations/:dataFlowValidationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataFlowValidationKey",
"value": "",
"type": "path",
"description": "The key of the dataflow validation."
}
]
},
"docs": "Retrieves a data flow validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to delete a data flow validation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlowValidations/:dataFlowValidationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataFlowValidationKey",
"value": "",
"type": "path",
"description": "The key of the dataflow validation."
}
]
},
"docs": "Removes a data flow validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a list of all data flows in a project or folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlows",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "folderId",
"value": "",
"type": "query",
"description": "Unique key of the folder."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of data flows in a project or folder.\n"
},
{
"info": {
"name": "Use this endpoint to create a new data flow object for specifying the data transformations that need to performed.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlows",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new data flow in a project or folder ready for performing data integrations.\n"
},
{
"info": {
"name": "Use this endpoint to get a data flow.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlows/:dataFlowKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataFlowKey",
"value": "",
"type": "path",
"description": "The data flow key."
},
{
"name": "expandReferences",
"value": "",
"type": "query",
"description": "Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
Example:
- ?expandReferences=true returns all objects of type data loader task
"
}
]
},
"docs": "Retrieves a data flow using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the data flow object identified by the key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlows/:dataFlowKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataFlowKey",
"value": "",
"type": "path",
"description": "The data flow key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific data flow."
},
{
"info": {
"name": "Use this endpoint to delete a data flow.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/dataFlows/:dataFlowKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "dataFlowKey",
"value": "",
"type": "path",
"description": "The data flow key."
}
]
},
"docs": "Removes a data flow from a project or folder using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list DIS applications in a given compartment with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the published object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
},
{
"name": "compartmentId",
"value": "",
"type": "query",
"description": "OCID of the compartment for which the list of DIS Applications is to be retrieved."
}
]
},
"docs": "Retrieves a list of DIS Applications in a compartment and provides options to filter the list."
},
{
"info": {
"name": "Use this endpoint to create a DIS application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a DIS Application.\n"
},
{
"info": {
"name": "Use this endpoint to get the detailed description of an Application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:applicationKey/detailedDescription",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
]
},
"docs": "Retrieves detailed description of an Application."
},
{
"info": {
"name": "Use this endpoint to create detailed description for an application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:applicationKey/detailedDescription",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates detailed description for an application."
},
{
"info": {
"name": "Use this endpoint to change the detailed description of an Application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:applicationKey/detailedDescription",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the detailed description of an Application."
},
{
"info": {
"name": "Use this endpoint to delete detailed description of an Application.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:applicationKey/detailedDescription",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "applicationKey",
"value": "",
"type": "path",
"description": "The application key."
}
]
},
"docs": "Deletes detailed description of an Application."
},
{
"info": {
"name": "Use this endpoint to get a DIS application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:disApplicationId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "disApplicationId",
"value": "",
"type": "path",
"description": "The OCID of the DIS Application."
}
]
},
"docs": "Retrieves an application using the specified OCID."
},
{
"info": {
"name": "Use this endpoint to update a DIS application.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:disApplicationId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "disApplicationId",
"value": "",
"type": "path",
"description": "The OCID of the DIS Application."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a DIS Application."
},
{
"info": {
"name": "Use this endpoint to delete a DIS application.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:disApplicationId",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "disApplicationId",
"value": "",
"type": "path",
"description": "The OCID of the DIS Application."
}
]
},
"docs": "Removes a DIS application using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to move a DIS Application to reside in a specified compartment.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:disApplicationId/actions/changeCompartment",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "disApplicationId",
"value": "",
"type": "path",
"description": "The OCID of the DIS Application."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Moves a DIS Application to a specified compartment.\n"
},
{
"info": {
"name": "Lists Task Run Lineages with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/disApplications/:disApplicationId/taskRunLineages",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "disApplicationId",
"value": "",
"type": "path",
"description": "The OCID of the DIS Application."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "This filter parameter can be used to filter by model specific queryable fields of the object
Examples:-
- ?filter=status eq Failed returns all objects that have a status field with value Failed
"
},
{
"name": "timeUpdatedGreaterThan",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
},
{
"name": "timeUpdatedGreaterThanOrEqualTo",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
},
{
"name": "timeUpatedLessThan",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
},
{
"name": "timeUpatedLessThanOrEqualTo",
"value": "",
"type": "query",
"description": "This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is \"YYYY-MM-dd'T'HH:mm:ss.SSS'Z'\""
}
]
},
"docs": "This endpoint can be used to list Task Run Lineages within a given time window.\n"
},
{
"info": {
"name": "List export object requests.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/exportRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "exportStatus",
"value": "",
"type": "query",
"description": "Specifies export status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED ."
},
{
"name": "projection",
"value": "",
"type": "query",
"description": "This parameter allows users to specify which view of the export object response to return. SUMMARY - Summary of the export object request will be returned. This is the default option when no value is specified. DETAILS - Details of export object request will be returned. This will include details of all the objects to be exported."
},
{
"name": "timeStartedInMillis",
"value": "",
"type": "query",
"description": "Specifies start time of a copy object request."
},
{
"name": "timeEndedInMillis",
"value": "",
"type": "query",
"description": "Specifies end time of a copy object request."
}
]
},
"docs": "This endpoint can be used to get the list of export object requests.\n"
},
{
"info": {
"name": "Use this endpoint to export objects",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/exportRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Export Metadata Object"
},
{
"info": {
"name": "Get export object request summary/details by key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/exportRequests/:exportRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "exportRequestKey",
"value": "",
"type": "path",
"description": "The key of the object export object request"
}
]
},
"docs": "This endpoint can be used to get the summary/details of object being exported.\n"
},
{
"info": {
"name": "Use this endpoint to change the status of a export object request. For example, cancel a export object request.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/exportRequests/:exportRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "exportRequestKey",
"value": "",
"type": "path",
"description": "The key of the object export object request"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the status of a export object request."
},
{
"info": {
"name": "Use this endpoint to delete export object request.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/exportRequests/:exportRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "exportRequestKey",
"value": "",
"type": "path",
"description": "The key of the object export object request"
}
]
},
"docs": "Delete export object request using the specified identifier.\n"
},
{
"info": {
"name": "Use this endpoint to list the folders in a project.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/folders",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "aggregatorKey",
"value": "",
"type": "query",
"description": "Used to filter by the project or the folder object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of folders in a project and provides options to filter the list.\n"
},
{
"info": {
"name": "Use this endpoint to create a folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/folders",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a folder in a project or in another folder, limited to two levels of folders. |\nFolders are used to organize your design-time resources, such as tasks or data flows.\n"
},
{
"info": {
"name": "Use this endpoint to get a folder using its key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/folders/:folderKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "folderKey",
"value": "",
"type": "path",
"description": "The folder key."
},
{
"name": "projection",
"value": "",
"type": "query",
"description": "This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type."
}
]
},
"docs": "Retrieves a folder using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the `Folder` object identified by its key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/folders/:folderKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "folderKey",
"value": "",
"type": "path",
"description": "The folder key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific folder."
},
{
"info": {
"name": "Use this endpoint to delete a `Folder` object.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/folders/:folderKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "folderKey",
"value": "",
"type": "path",
"description": "The folder key."
}
]
},
"docs": "Removes a folder from a project using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list the function libraries in a project.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/functionLibraries",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "aggregatorKey",
"value": "",
"type": "query",
"description": "Used to filter by the project or the folder object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a list of function libraries in a project and provides options to filter the list.\n"
},
{
"info": {
"name": "Use this endpoint to create a function Library.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/functionLibraries",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a function library in a project or in another function library, limited to two levels of function libraries. |\nFunctionLibraries are used to organize your design-time resources, such as tasks or data flows.\n"
},
{
"info": {
"name": "Use this endpoint to get a Function Library using its key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/functionLibraries/:functionLibraryKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "functionLibraryKey",
"value": "",
"type": "path",
"description": "The functionLibrary key."
},
{
"name": "projection",
"value": "",
"type": "query",
"description": "This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type."
}
]
},
"docs": "Retrieves a Function Library using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the `FunctionLibrary` object identified by its key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/functionLibraries/:functionLibraryKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "functionLibraryKey",
"value": "",
"type": "path",
"description": "The functionLibrary key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific Function Library."
},
{
"info": {
"name": "Use this endpoint to delete a `FunctionLibrary` object.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/functionLibraries/:functionLibraryKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "functionLibraryKey",
"value": "",
"type": "path",
"description": "The functionLibrary key."
}
]
},
"docs": "Removes a Function Library from a project using the specified identifier."
},
{
"info": {
"name": "List import object requests.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/importRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "importStatus",
"value": "",
"type": "query",
"description": "Specifies import status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED ."
},
{
"name": "projection",
"value": "",
"type": "query",
"description": "This parameter allows users to specify which view of the import object response to return. SUMMARY - Summary of the import object request will be returned. This is the default option when no value is specified. DETAILS - Details of import object request will be returned. This will include details of all the objects to be exported."
},
{
"name": "timeStartedInMillis",
"value": "",
"type": "query",
"description": "Specifies start time of a copy object request."
},
{
"name": "timeEndedInMillis",
"value": "",
"type": "query",
"description": "Specifies end time of a copy object request."
}
]
},
"docs": "This endpoint can be used to get the list of import object requests.\n"
},
{
"info": {
"name": "Use this endpoint to import an object",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/importRequests",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import Metadata Object"
},
{
"info": {
"name": "Get import object request summary/details by key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/importRequests/:importRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "importRequestKey",
"value": "",
"type": "path",
"description": "The key of the object export object request"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
}
]
},
"docs": "This endpoint can be used to get the summary/details of object being imported.\n"
},
{
"info": {
"name": "Use this endpoint to change the status of a import object request. For example, cancel a import object request.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/importRequests/:importRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "importRequestKey",
"value": "",
"type": "path",
"description": "The key of the object export object request"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the status of a import object request."
},
{
"info": {
"name": "Use this endpoint to delete import object request.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/importRequests/:importRequestKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "importRequestKey",
"value": "",
"type": "path",
"description": "The key of the object export object request"
},
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Delete import object request using the specified identifier.\n"
},
{
"info": {
"name": "Use this endpoint to get a list of pipeline validations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelineValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
}
]
},
"docs": "Retrieves a list of pipeline validations within the specified workspace."
},
{
"info": {
"name": "Use this endpoint to execute a pipeline validation.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelineValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts the data flow definition in the request payload and creates a pipeline validation.\n"
},
{
"info": {
"name": "Use this endpoint to gets a pipeline validation using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelineValidations/:pipelineValidationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "pipelineValidationKey",
"value": "",
"type": "path",
"description": "The key of the pipeline validation."
}
]
},
"docs": "Retrieves a pipeline validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to delete a pipeline validation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelineValidations/:pipelineValidationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "pipelineValidationKey",
"value": "",
"type": "path",
"description": "The key of the pipeline validation."
}
]
},
"docs": "Removes a pipeline validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a list of all pipelines in a project or folder within a workspace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelines",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "aggregatorKey",
"value": "",
"type": "query",
"description": "Used to filter by the project or the folder object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.\n"
},
{
"info": {
"name": "Use this endpoint to create a new pipeline object for specifying the orchestration operations that need to performed.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelines",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new pipeline in a project or folder ready for performing task orchestration.\n"
},
{
"info": {
"name": "Use this endpoint to get a pipeline.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelines/:pipelineKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "pipelineKey",
"value": "",
"type": "path",
"description": "The pipeline key."
},
{
"name": "expandReferences",
"value": "",
"type": "query",
"description": "Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
Example:
- ?expandReferences=true returns all objects of type data loader task
"
}
]
},
"docs": "Retrieves a pipeline using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the pipeline object identified by the key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelines/:pipelineKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "pipelineKey",
"value": "",
"type": "path",
"description": "The pipeline key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific pipeline."
},
{
"info": {
"name": "Use this endpoint to delete a pipeline.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/pipelines/:pipelineKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "pipelineKey",
"value": "",
"type": "path",
"description": "The pipeline key."
}
]
},
"docs": "Removes a pipeline from a project or folder using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list projects in the workspace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/projects",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "nameContains",
"value": "",
"type": "query",
"description": "This parameter can be used to filter objects by the names that match partially or fully with the given value."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a lists of projects in a workspace and provides options to filter the list.\n"
},
{
"info": {
"name": "Use this endpoint to create a project.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/projects",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a project. Projects are organizational constructs within a workspace that you use to organize your design-time resources, such as tasks or data flows. Projects can be organized into folders.\n"
},
{
"info": {
"name": "Use this endpoint to get a project using its key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/projects/:projectKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "projectKey",
"value": "",
"type": "path",
"description": "The project key."
},
{
"name": "projection",
"value": "",
"type": "query",
"description": "This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type."
}
]
},
"docs": "Retrieves a project using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the `Project` object identified by the key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/projects/:projectKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "projectKey",
"value": "",
"type": "path",
"description": "The project key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific project."
},
{
"info": {
"name": "Use this endpoint to delete a `Project` object.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/projects/:projectKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "projectKey",
"value": "",
"type": "path",
"description": "The project key."
}
]
},
"docs": "Removes a project from the workspace using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a list of task validations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/taskValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
}
]
},
"docs": "Retrieves a list of task validations within the specified workspace.\n"
},
{
"info": {
"name": "Use this endpoint to validate a task.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/taskValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
]
},
"docs": "Validates a specific task."
},
{
"info": {
"name": "Use this endpoint to get a task validation using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/taskValidations/:taskValidationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskValidationKey",
"value": "",
"type": "path",
"description": "The task validation key."
}
]
},
"docs": "Retrieves a task validation using the specified identifier.\n"
},
{
"info": {
"name": "Use this endpoint to delete a task validation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/taskValidations/:taskValidationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskValidationKey",
"value": "",
"type": "path",
"description": "The task validation key."
}
]
},
"docs": "Removes a task validation using the specified identifier.\n"
},
{
"info": {
"name": "Use this endpoint to get a list of all tasks in a specified project or folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "folderId",
"value": "",
"type": "query",
"description": "Unique key of the folder."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
Examples:
- ?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task
- ?type=DATA_LOADER_TASK returns all objects of type data loader task
- ?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task
"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of all tasks in a specified project or folder.\n"
},
{
"info": {
"name": "Use this endpoint to create a new task. Tasks can be data loading tasks or integration tasks.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new task ready for performing data integrations. There are specialized types of tasks that include data loader and integration tasks.\n"
},
{
"info": {
"name": "Use this endpoint to get a task.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "expandReferences",
"value": "",
"type": "query",
"description": "Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
Example:
- ?expandReferences=true returns all objects of type data loader task
"
}
]
},
"docs": "Retrieves a task using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update a task.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific task. For example, you can update the task description or move the task to a different folder by changing the `aggregatorKey` to a different folder in the registry."
},
{
"info": {
"name": "Use this endpoint to delete a task.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
}
]
},
"docs": "Removes a task using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to list external publication validations in the workspace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublicationValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "Retrieves a lists of external publication validations in a workspace and provides options to filter the list.\n"
},
{
"info": {
"name": "Use this endpoint to validate a task that is externally published to OCI DataFlow.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublicationValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validates a specific task."
},
{
"info": {
"name": "Use this endpoint to get a project using its key.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublicationValidations/:externalPublicationValidationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "externalPublicationValidationKey",
"value": "",
"type": "path",
"description": "The external published object key."
}
]
},
"docs": "Retrieves an external publication validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to delete a task validation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublicationValidations/:externalPublicationValidationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "externalPublicationValidationKey",
"value": "",
"type": "path",
"description": "The external published object key."
}
]
},
"docs": "Removes a task validation using the specified identifier.\n"
},
{
"info": {
"name": "Use this endpoint to list external publication objects with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublications",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of external publications in an application and provides options to filter the list."
},
{
"info": {
"name": "Use this endpoint to publish a task in a OCI Data Flow Application.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublications",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Publish a DataFlow in a OCI DataFlow application."
},
{
"info": {
"name": "Use this endpoint to get an externalPublished object in an application.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublications/:externalPublicationsKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "externalPublicationsKey",
"value": "",
"type": "path",
"description": "The external published object key."
}
]
},
"docs": "Retrieves a publshed object in an task using the specified identifier."
},
{
"info": {
"name": "Update the external publication object identified by the key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublications/:externalPublicationsKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "externalPublicationsKey",
"value": "",
"type": "path",
"description": "The external published object key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the external publication object."
},
{
"info": {
"name": "Use this endpoint to delete a published object.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/tasks/:taskKey/externalPublications/:externalPublicationsKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "taskKey",
"value": "",
"type": "path",
"description": "The task key."
},
{
"name": "externalPublicationsKey",
"value": "",
"type": "path",
"description": "The external published object key."
}
]
},
"docs": "Removes a published object using the specified identifier."
},
{
"info": {
"name": "Lists application templates with filtering options.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/templates",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the published object.\n"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
}
]
},
"docs": "This endpoint can be used to list application templates with filtering options."
},
{
"info": {
"name": "Gets an application template.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/templates/:templateId",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "templateId",
"value": "",
"type": "path",
"description": "The OCID of the template."
}
]
},
"docs": "This endpoint can be used to get an application template using a key."
},
{
"info": {
"name": "Use this endpoint to get a list of UserDefinedFunction validations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctionValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "Used to filter by the key of the object."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
}
]
},
"docs": "Retrieves a list of UserDefinedFunctionvalidations within the specified workspace."
},
{
"info": {
"name": "Use this endpoint to execute a UserDefinedFunction validation.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctionValidations",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "opc-retry-token",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.\n"
},
{
"info": {
"name": "Use this endpoint to gets a UserDefinedFunction validation using the specified identifier.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctionValidations/:userDefinedFunctionValidationKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "userDefinedFunctionValidationKey",
"value": "",
"type": "path",
"description": "The key of the userDefinedFunction validation."
}
]
},
"docs": "Retrieves a UserDefinedFunction validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to delete a UserDefinedFunction validation.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctionValidations/:userDefinedFunctionValidationKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "userDefinedFunctionValidationKey",
"value": "",
"type": "path",
"description": "The key of the userDefinedFunction validation."
}
]
},
"docs": "Removes a UserDefinedFunction validation using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to get a list of all UserDefinedFunctions in a project or function library.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctions",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "functionLibraryKey",
"value": "",
"type": "query",
"description": "Unique key of the FunctionLibrary."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Used to filter by the name of the object."
},
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Used to filter by the identifier of the object."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine)."
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending)."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order)."
},
{
"name": "favoritesQueryParam",
"value": "",
"type": "query",
"description": "If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL."
}
]
},
"docs": "Retrieves a list of UserDefinedFunctions in a function library.\n"
},
{
"info": {
"name": "Use this endpoint to create a new UserDefinedFunction object for specifying the data transformations that need to performed.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctions",
"headers": [
{
"name": "opc-retry-token",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new UserDefinedFunction in a function library ready for performing data integrations.\n"
},
{
"info": {
"name": "Use this endpoint to get a UserDefinedFunction.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctions/:userDefinedFunctionKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "userDefinedFunctionKey",
"value": "",
"type": "path",
"description": "The user defined function key."
}
]
},
"docs": "Retrieves a UserDefinedFunction using the specified identifier."
},
{
"info": {
"name": "Use this endpoint to update the UserDefinedFunction object identified by the key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctions/:userDefinedFunctionKey",
"headers": [
{
"name": "opc-request-id",
"value": ""
},
{
"name": "if-match",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "userDefinedFunctionKey",
"value": "",
"type": "path",
"description": "The user defined function key."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a specific UserDefinedFunction."
},
{
"info": {
"name": "Use this endpoint to delete a UserDefinedFunction.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://localhost:8484/20200430/workspaces/:workspaceId/userDefinedFunctions/:userDefinedFunctionKey",
"headers": [
{
"name": "if-match",
"value": ""
},
{
"name": "opc-request-id",
"value": ""
}
],
"params": [
{
"name": "workspaceId",
"value": "",
"type": "path",
"description": "The workspace ID."
},
{
"name": "userDefinedFunctionKey",
"value": "",
"type": "path",
"description": "The user defined function key."
}
]
},
"docs": "Removes a UserDefinedFunction from a function library using the specified identifier."
}
]
}
],
"bundled": true
}