{ "opencollection": "1.0.0", "info": { "name": "Data Catalog API", "version": "20190325" }, "items": [ { "info": { "name": "dataCatalog", "type": "folder" }, "items": [ { "info": { "name": "Lists all the catalog private endpoints in the specified compartment", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogPrivateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment where you want to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" } ] }, "docs": "Returns a list of all the catalog private endpoints in the specified compartment.\n" }, { "info": { "name": "Create a new private reverse connection endpoint.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogPrivateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new private reverse connection endpoint." }, { "info": { "name": "Get private reverse connection endpoint.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogPrivateEndpoints/:catalogPrivateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogPrivateEndpointId", "value": "", "type": "path", "description": "Unique private reverse connection identifier." } ] }, "docs": "Gets a specific private reverse connection by identifier." }, { "info": { "name": "Update the private reverse connection endpoint identified by the id.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogPrivateEndpoints/:catalogPrivateEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogPrivateEndpointId", "value": "", "type": "path", "description": "Unique private reverse connection identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the private reverse connection endpoint." }, { "info": { "name": "Delete a private reverse connection endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogPrivateEndpoints/:catalogPrivateEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogPrivateEndpointId", "value": "", "type": "path", "description": "Unique private reverse connection identifier." } ] }, "docs": "Deletes a private reverse connection endpoint by identifier." }, { "info": { "name": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogPrivateEndpoints/:catalogPrivateEndpointId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogPrivateEndpointId", "value": "", "type": "path", "description": "Unique private reverse connection identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource." }, { "info": { "name": "Lists all the data catalogs in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment where you want to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" } ] }, "docs": "Returns a list of all the data catalogs in the specified compartment.\n" }, { "info": { "name": "Creates a new data catalog.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.\nFor more information, please see the documentation.\n" }, { "info": { "name": "Get data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ] }, "docs": "Gets a data catalog by identifier." }, { "info": { "name": "Update the data catalog identified by the id.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the data catalog." }, { "info": { "name": "Delete a provisioned data catalog.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ] }, "docs": "Deletes a data catalog resource by identifier." }, { "info": { "name": "Attaches a private reverse connection endpoint resource to a data catalog resource.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/attachCatalogPrivateEndpoint", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource." }, { "info": { "name": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource." }, { "info": { "name": "Detaches a private reverse connection endpoint resource to a data catalog resource.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/detachCatalogPrivateEndpoint", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource." }, { "info": { "name": "Returns a list of recommendations for the given object and recommendation type.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/getRecommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "recommendationType", "value": "", "type": "query", "description": "A filter used to return only recommendations of the specified type." }, { "name": "sourceObjectKey", "value": "", "type": "query", "description": "A filter used to provide the unique identifier of the source object, for which a list of recommendations will be returned for review." }, { "name": "sourceObjectType", "value": "", "type": "query", "description": "A filter used to provide the type of the source object, for which a list of recommendations will be returned for review." }, { "name": "recommendationStatus", "value": "", "type": "query", "description": "A filter used to return only recommendations having the requested status." } ] }, "docs": "Returns a list of recommendations for the given object and recommendation type.\nBy default, it will return inferred recommendations for review. The optional query param 'RecommendationStatus' can be set,\nto return only recommendations having that status.\n" }, { "info": { "name": "Returns stats on objects in the repository.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/objectStats", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns stats on objects by type in the repository." }, { "info": { "name": "Act on a recommendation.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/processRecommendation", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Act on a recommendation. A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM\nis accepted, the system will link the source object (e.g. an attribute) to a target glossary term.\n" }, { "info": { "name": "Returns a list of potential string matches for a given input string.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/suggest", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "timeout", "value": "", "type": "query", "description": "A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the\nspecified time value and bail with the hits accumulated up to that point when expired.\nDefaults to no timeout.\n" }, { "name": "inputText", "value": "", "type": "query", "description": "Text input string used for computing potential matching suggestions.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10.\n" } ] }, "docs": "Returns a list of potential string matches for a given input string." }, { "info": { "name": "Returns active users in the system.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/actions/users", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns active users in the system." }, { "info": { "name": "Returns a list of data assets within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "externalKey", "value": "", "type": "query", "description": "Unique external identifier of this resource in the external source system." }, { "name": "typeKey", "value": "", "type": "query", "description": "The key of the object type." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a data asset summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of data assets within a data catalog." }, { "info": { "name": "Create a new data asset.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new data asset." }, { "info": { "name": "Get a specific data asset for the given key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a data asset response.\n" } ] }, "docs": "Gets a specific data asset for the given key within a data catalog." }, { "info": { "name": "Update a specific data asset identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific data asset identified by the given key." }, { "info": { "name": "Delete a specific data asset identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ] }, "docs": "Deletes a specific data asset identified by it's key." }, { "info": { "name": "Add data selector pattern to the data asset used to derive logical entities during harvesting.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/addDataSelectorPatterns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add data selector pattern to the data asset." }, { "info": { "name": "Export technical objects from a Data Asset in Excel format.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/asynchronousExport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "exportType", "value": "", "type": "query", "description": "Type of export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export." }, { "info": { "name": "Import technical objects to a Data Asset from an exported file.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/import", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "importType", "value": "", "type": "query", "description": "Type of import." }, { "name": "isMissingValueIgnored", "value": "", "type": "query", "description": "Specify whether to ignore the missing values in the import file." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import technical objects to a Data Asset" }, { "info": { "name": "Import connections from an Oracle wallet file that contains relevant metadata for creating connections.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/importConnection", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import new connection for this data asset." }, { "info": { "name": "Imports lineage metadata.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/importLineage", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports lineage metadata. Returns details about the job that performs the import." }, { "info": { "name": "Parse connection from a request payload that contains data asset references.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/parseConnection", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "connectionKey", "value": "", "type": "query", "description": "Unique connection key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Parse data asset references through connections from this data asset." }, { "info": { "name": "Remove data selector pattern from the data asset used in deriving logical entities during harvesting.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/removeDataSelectorPatterns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove data selector pattern from the data asset." }, { "info": { "name": "Export technical objects from a Data Asset in Excel file format.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/synchronousExport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "exportType", "value": "", "type": "query", "description": "Type of export." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export technical objects from a Data Asset" }, { "info": { "name": "Validate connection from a request payload that contains connection metadata.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/actions/validateConnection", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate connection by connecting to the data asset using credentials in metadata." }, { "info": { "name": "Returns a list of all connections for a data asset.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "externalKey", "value": "", "type": "query", "description": "Unique external identifier of this resource in the external source system." }, { "name": "timeStatusUpdated", "value": "", "type": "query", "description": "Time that the resource's status was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "isDefault", "value": "", "type": "query", "description": "Indicates whether this connection is the default connection." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a connection summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all Connections for a data asset." }, { "info": { "name": "Create a new connection.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new connection." }, { "info": { "name": "Get a specific data asset connection by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections/:connectionKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "connectionKey", "value": "", "type": "path", "description": "Unique connection key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a connection response.\n" } ] }, "docs": "Gets a specific data asset connection by key." }, { "info": { "name": "Update a specific connection of a data asset.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections/:connectionKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "connectionKey", "value": "", "type": "path", "description": "Unique connection key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific connection of a data asset." }, { "info": { "name": "Delete a specific connection of a data asset.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections/:connectionKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "connectionKey", "value": "", "type": "path", "description": "Unique connection key." } ] }, "docs": "Deletes a specific connection of a data asset." }, { "info": { "name": "Test the connection credentials to the parent data asset.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections/:connectionKey/actions/test", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "connectionKey", "value": "", "type": "path", "description": "Unique connection key." } ] }, "docs": "Test the connection by connecting to the data asset using credentials in the metadata." }, { "info": { "name": "Upload connection credentials file and metadata for this connection for update.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/connections/:connectionKey/actions/uploadCredentials", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "connectionKey", "value": "", "type": "path", "description": "Unique connection key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload connection credentails and metadata for this connection." }, { "info": { "name": "Returns a list of all entities of a data asset.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "businessName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire business name given. The match is not case sensitive." }, { "name": "displayOrBusinessNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.\nFor Example : /folders?displayOrBusinessNameContains=Cu.*\nThe above would match all folders with display name or business name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "typeKey", "value": "", "type": "query", "description": "The key of the object type." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "externalKey", "value": "", "type": "query", "description": "Unique external identifier of this resource in the external source system." }, { "name": "patternKey", "value": "", "type": "query", "description": "Unique pattern key." }, { "name": "timeExternal", "value": "", "type": "query", "description": "Last modified timestamp of this object in the external system." }, { "name": "timeStatusUpdated", "value": "", "type": "query", "description": "Time that the resource's status was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "isLogical", "value": "", "type": "query", "description": "Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.\n" }, { "name": "isPartition", "value": "", "type": "query", "description": "Identifies if an object is a sub object (partition) of a physical or materialized parent object." }, { "name": "folderKey", "value": "", "type": "query", "description": "Key of the associated folder." }, { "name": "path", "value": "", "type": "query", "description": "Full path of the resource for resources that support paths." }, { "name": "harvestStatus", "value": "", "type": "query", "description": "Harvest status of the harvestable resource as updated by the harvest process." }, { "name": "lastJobKey", "value": "", "type": "query", "description": "Key of the last harvest process to update this resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.\nDefault sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "isProcess", "value": "", "type": "query", "description": "A filter to return only process entities." } ] }, "docs": "Returns a list of all entities of a data asset." }, { "info": { "name": "Create a new data entity.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new data entity." }, { "info": { "name": "Get a specific data entity by key for a data asset.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "isIncludeObjectRelationships", "value": "", "type": "query", "description": "Indicates whether the list of objects and their relationships to this object will be provided in the response." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity response.\n" } ] }, "docs": "Gets a specific data entity by key for a data asset." }, { "info": { "name": "Update a specific data entity.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific data entity." }, { "info": { "name": "Delete a specific data entity.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." } ] }, "docs": "Deletes a specific data entity." }, { "info": { "name": "Returns lineage for a given entity object.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/actions/fetchLineage", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns lineage for a given entity object." }, { "info": { "name": "List the physical entities aggregated by this logical entity.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/actions/listAggregatedPhysicalEntities", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity response.\n" }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "isIncludeProperties", "value": "", "type": "query", "description": "Indicates whether the properties map will be provided in the response." } ] }, "docs": "List the physical entities aggregated by this logical entity." }, { "info": { "name": "Returns a list of all attributes of an data entity.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "businessName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire business name given. The match is not case sensitive." }, { "name": "displayOrBusinessNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.\nFor Example : /folders?displayOrBusinessNameContains=Cu.*\nThe above would match all folders with display name or business name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "externalKey", "value": "", "type": "query", "description": "Unique external identifier of this resource in the external source system." }, { "name": "timeExternal", "value": "", "type": "query", "description": "Last modified timestamp of this object in the external system." }, { "name": "externalTypeName", "value": "", "type": "query", "description": "Data type as defined in an external system." }, { "name": "isIncrementalData", "value": "", "type": "query", "description": "Identifies whether this attribute can be used as a watermark to extract incremental data." }, { "name": "isNullable", "value": "", "type": "query", "description": "Identifies whether this attribute can be assigned null value." }, { "name": "length", "value": "", "type": "query", "description": "Max allowed length of the attribute value." }, { "name": "position", "value": "", "type": "query", "description": "Position of the attribute in the record definition." }, { "name": "precision", "value": "", "type": "query", "description": "Precision of the attribute value usually applies to float data type." }, { "name": "scale", "value": "", "type": "query", "description": "Scale of the attribute value usually applies to float data type." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity attribute summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.\nDefault sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all attributes of an data entity." }, { "info": { "name": "Create a new entity attribute.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new entity attribute." }, { "info": { "name": "Get a specific entity attribute by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." }, { "name": "isIncludeObjectRelationships", "value": "", "type": "query", "description": "Indicates whether the list of objects and their relationships to this object will be provided in the response." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity attribute response.\n" } ] }, "docs": "Gets a specific entity attribute by key." }, { "info": { "name": "Update a specific data asset attribute.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific data asset attribute." }, { "info": { "name": "Delete a specific entity attribute.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." } ] }, "docs": "Deletes a specific entity attribute." }, { "info": { "name": "Returns a list of all tags for an entity attribute.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey/tags", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." }, { "name": "name", "value": "", "type": "query", "description": "Immutable resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "termKey", "value": "", "type": "query", "description": "Unique key of the related term." }, { "name": "termPath", "value": "", "type": "query", "description": "Path of the related term." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity attribute tag summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all tags for an entity attribute." }, { "info": { "name": "Create a new entity attribute tag.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey/tags", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new entity attribute tag." }, { "info": { "name": "Get a specific entity attribute tag by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey/tags/:tagKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity attribute tag response.\n" } ] }, "docs": "Gets a specific entity attribute tag by key." }, { "info": { "name": "Delete a specific entity attribute tag.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/attributes/:attributeKey/tags/:tagKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "attributeKey", "value": "", "type": "path", "description": "Unique attribute key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." } ] }, "docs": "Deletes a specific entity attribute tag." }, { "info": { "name": "Returns a list of all rules of a data entity.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/rules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "ruleType", "value": "", "type": "query", "description": "Rule type used to filter the response to a list rules call." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "originType", "value": "", "type": "query", "description": "Rule origin type used to filter the response to a list rules call." }, { "name": "externalKey", "value": "", "type": "query", "description": "Unique external identifier of this resource in the external source system." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a rule summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all rules of a data entity." }, { "info": { "name": "Returns a list of all tags for a data entity.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/tags", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "name", "value": "", "type": "query", "description": "Immutable resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "termKey", "value": "", "type": "query", "description": "Unique key of the related term." }, { "name": "termPath", "value": "", "type": "query", "description": "Path of the related term." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity tag summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all tags for a data entity." }, { "info": { "name": "Create a new entity tag.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/tags", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new entity tag." }, { "info": { "name": "Get a specific entity tag by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/tags/:tagKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in an entity tag response.\n" } ] }, "docs": "Gets a specific entity tag by key." }, { "info": { "name": "Delete a specific entity tag.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/entities/:entityKey/tags/:tagKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "entityKey", "value": "", "type": "path", "description": "Unique entity key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." } ] }, "docs": "Deletes a specific entity tag." }, { "info": { "name": "Returns a list of all folders for a data asset.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "businessName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire business name given. The match is not case sensitive." }, { "name": "displayOrBusinessNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.\nFor Example : /folders?displayOrBusinessNameContains=Cu.*\nThe above would match all folders with display name or business name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "parentFolderKey", "value": "", "type": "query", "description": "Unique folder key." }, { "name": "path", "value": "", "type": "query", "description": "Full path of the resource for resources that support paths." }, { "name": "externalKey", "value": "", "type": "query", "description": "Unique external identifier of this resource in the external source system." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "harvestStatus", "value": "", "type": "query", "description": "Harvest status of the harvestable resource as updated by the harvest process." }, { "name": "lastJobKey", "value": "", "type": "query", "description": "Key of the last harvest process to update this resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a folder summary response.\n" }, { "name": "typeKey", "value": "", "type": "query", "description": "The key of the object type." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.\nDefault sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all folders." }, { "info": { "name": "Create a new folder.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new folder." }, { "info": { "name": "Get a specific data asset folder by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." }, { "name": "isIncludeObjectRelationships", "value": "", "type": "query", "description": "Indicates whether the list of objects and their relationships to this object will be provided in the response." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a folder response.\n" } ] }, "docs": "Gets a specific data asset folder by key." }, { "info": { "name": "Update a specific folder of a data asset.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific folder of a data asset." }, { "info": { "name": "Delete a specific folder of a data asset identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." } ] }, "docs": "Deletes a specific folder of a data asset identified by it's key." }, { "info": { "name": "Returns a list of all tags for a folder.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey/tags", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." }, { "name": "name", "value": "", "type": "query", "description": "Immutable resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "termKey", "value": "", "type": "query", "description": "Unique key of the related term." }, { "name": "termPath", "value": "", "type": "query", "description": "Path of the related term." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a folder tag summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all tags for a folder." }, { "info": { "name": "Create a new folder tag.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey/tags", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new folder tag." }, { "info": { "name": "Get a specific folder tag by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey/tags/:tagKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a folder tag response.\n" } ] }, "docs": "Gets a specific folder tag by key." }, { "info": { "name": "Delete a specific folder tag.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/folders/:folderKey/tags/:tagKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "folderKey", "value": "", "type": "path", "description": "Unique folder key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." } ] }, "docs": "Deletes a specific folder tag." }, { "info": { "name": "Returns a list of all tags for a data asset.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/tags", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "name", "value": "", "type": "query", "description": "Immutable resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "termKey", "value": "", "type": "query", "description": "Unique key of the related term." }, { "name": "termPath", "value": "", "type": "query", "description": "Path of the related term." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a data asset tag summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all tags for a data asset." }, { "info": { "name": "Create a new data asset tag.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/tags", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new data asset tag." }, { "info": { "name": "Get a specific data asset tag by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/tags/:tagKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a data asset tag response.\n" } ] }, "docs": "Gets a specific data asset tag by key." }, { "info": { "name": "Delete a specific data asset tag.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/dataAssets/:dataAssetKey/tags/:tagKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "dataAssetKey", "value": "", "type": "path", "description": "Unique data asset key." }, { "name": "tagKey", "value": "", "type": "path", "description": "Unique tag key." } ] }, "docs": "Deletes a specific data asset tag." }, { "info": { "name": "Returns a list of all glossaries within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/glossaries", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a glossary summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all glossaries within a data catalog." }, { "info": { "name": "Create a new glossary.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new glossary." }, { "info": { "name": "Get a specific glossary by key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a glossary response.\n" } ] }, "docs": "Gets a specific glossary by key within a data catalog." }, { "info": { "name": "Update a specific glossary identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific glossary identified by the given key." }, { "info": { "name": "Delete a specific glossary identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." } ] }, "docs": "Deletes a specific glossary identified by it's key." }, { "info": { "name": "Exports the contents of a glossary in Excel format.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/actions/asynchronousExport", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.\n" }, { "info": { "name": "Glossaries contain nested hierarchies of parent and child terms. Returns an expanded tree of this glossary.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/actions/expandTree", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." } ] }, "docs": "Returns the fully expanded tree hierarchy of parent and child terms in this glossary." }, { "info": { "name": "Glossaries can be exported as csv or json formats. Returns the succesfully exported glossary in the format requested.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/actions/export", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "isRelationshipExported", "value": "", "type": "query", "description": "Specify if the relationship metadata is exported for the glossary." } ] }, "docs": "Export the glossary and the terms and return the exported glossary as csv or json." }, { "info": { "name": "Glossaries can be imported from csv or json file formats. Returns the succesfully imported glossary.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/actions/import", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "isRelationshipImported", "value": "", "type": "query", "description": "Specify if the relationship metadata is imported for the glossary." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import the glossary and the terms from csv or json files and return the imported glossary resource." }, { "info": { "name": "Returns a list of all terms within a glossary.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "parentTermKey", "value": "", "type": "query", "description": "Unique key of the parent term." }, { "name": "isAllowedToHaveChildTerms", "value": "", "type": "query", "description": "Indicates whether a term may contain child terms." }, { "name": "workflowStatus", "value": "", "type": "query", "description": "Status of the approval workflow for this business term in the glossary." }, { "name": "path", "value": "", "type": "query", "description": "Full path of the resource for resources that support paths." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a term summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all terms within a glossary." }, { "info": { "name": "Create a new term within a glossary.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new term within a glossary." }, { "info": { "name": "Get a specific glossary term by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a term response.\n" } ] }, "docs": "Gets a specific glossary term by key." }, { "info": { "name": "Update a specific glossary term.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific glossary term." }, { "info": { "name": "Delete a specific glossary term.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." } ] }, "docs": "Deletes a specific glossary term." }, { "info": { "name": "Returns a list of all term relationships for a term within a glossary.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey/termRelationships", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a term relationship summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all term relationships within a glossary." }, { "info": { "name": "Create a new term relationship for this term within a glossary.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey/termRelationships", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new term relationship for this term within a glossary." }, { "info": { "name": "Get a specific glossary term relationship by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey/termRelationships/:termRelationshipKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." }, { "name": "termRelationshipKey", "value": "", "type": "path", "description": "Unique glossary term relationship key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a term relationship response.\n" } ] }, "docs": "Gets a specific glossary term relationship by key." }, { "info": { "name": "Update a specific glossary term relationship.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey/termRelationships/:termRelationshipKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." }, { "name": "termRelationshipKey", "value": "", "type": "path", "description": "Unique glossary term relationship key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific glossary term relationship." }, { "info": { "name": "Delete a specific glossary term relationship.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/glossaries/:glossaryKey/terms/:termKey/termRelationships/:termRelationshipKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "glossaryKey", "value": "", "type": "path", "description": "Unique glossary key." }, { "name": "termKey", "value": "", "type": "path", "description": "Unique glossary term key." }, { "name": "termRelationshipKey", "value": "", "type": "path", "description": "Unique glossary term relationship key." } ] }, "docs": "Deletes a specific glossary term relationship." }, { "info": { "name": "Returns a list of job definitions within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobDefinitions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "jobExecutionState", "value": "", "type": "query", "description": "Job execution state." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "jobType", "value": "", "type": "query", "description": "Job type." }, { "name": "isIncremental", "value": "", "type": "query", "description": "Whether job definition is an incremental harvest (true) or a full harvest (false)." }, { "name": "dataAssetKey", "value": "", "type": "query", "description": "Unique data asset key." }, { "name": "glossaryKey", "value": "", "type": "query", "description": "Unique glossary key." }, { "name": "connectionKey", "value": "", "type": "query", "description": "Unique connection key." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "sampleDataSizeInMBs", "value": "", "type": "query", "description": "The sample data size in MB, specified as number of rows, for a metadata harvest." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job definition summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of job definitions within a data catalog." }, { "info": { "name": "Create a new job definition.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/jobDefinitions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new job definition." }, { "info": { "name": "Get a specific job definition by key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobDefinitions/:jobDefinitionKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobDefinitionKey", "value": "", "type": "path", "description": "Unique job definition key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job definition response.\n" } ] }, "docs": "Gets a specific job definition by key within a data catalog." }, { "info": { "name": "Update a specific job definition identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/jobDefinitions/:jobDefinitionKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobDefinitionKey", "value": "", "type": "path", "description": "Unique job definition key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific job definition identified by the given key." }, { "info": { "name": "Delete a specific job definition identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/jobDefinitions/:jobDefinitionKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobDefinitionKey", "value": "", "type": "path", "description": "Unique job definition key." } ] }, "docs": "Deletes a specific job definition identified by it's key." }, { "info": { "name": "Returns a list of jobs within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Job lifecycle state." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "jobType", "value": "", "type": "query", "description": "Job type." }, { "name": "jobDefinitionKey", "value": "", "type": "query", "description": "Unique job definition key." }, { "name": "dataAssetKey", "value": "", "type": "query", "description": "Unique data asset key." }, { "name": "glossaryKey", "value": "", "type": "query", "description": "Unique glossary key." }, { "name": "scheduleCronExpression", "value": "", "type": "query", "description": "Interval on which the job will be run. Value is specified as a cron-supported time specification \"nickname\".\nThe following subset of those is supported: @monthly, @weekly, @daily, @hourly.\nFor metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.\n" }, { "name": "timeScheduleBegin", "value": "", "type": "query", "description": "Date that the schedule should be operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeScheduleEnd", "value": "", "type": "query", "description": "Date that the schedule should end from being operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "scheduleType", "value": "", "type": "query", "description": "Type of the job schedule." }, { "name": "connectionKey", "value": "", "type": "query", "description": "Unique connection key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job summary response.\n" }, { "name": "executionCount", "value": "", "type": "query", "description": "The total number of executions for this job schedule.\n" }, { "name": "timeOfLatestExecution", "value": "", "type": "query", "description": "The date and time the most recent execution for this job ,in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\nExample: `2019-03-25T21:10:29.600Z`\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of jobs within a data catalog." }, { "info": { "name": "Create a new job.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/jobs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new job." }, { "info": { "name": "Get a specific job by key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job response.\n" } ] }, "docs": "Gets a specific job by key within a data catalog." }, { "info": { "name": "Update a specific job identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific job identified by the given key." }, { "info": { "name": "Delete a specific job identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." } ] }, "docs": "Deletes a specific job identified by it's key." }, { "info": { "name": "Returns a list of job executions for a job.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Job execution lifecycle state." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "jobType", "value": "", "type": "query", "description": "Job type." }, { "name": "subType", "value": "", "type": "query", "description": "Sub-type of this job execution." }, { "name": "parentKey", "value": "", "type": "query", "description": "The unique key of the parent execution or null if this job execution has no parent." }, { "name": "timeStart", "value": "", "type": "query", "description": "Time that the job execution was started or in the case of a future time, the time when the job will start.\nAn [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.\n" }, { "name": "timeEnd", "value": "", "type": "query", "description": "Time that the job execution ended or null if the job is still running or hasn't run yet.\nAn [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.\n" }, { "name": "errorCode", "value": "", "type": "query", "description": "Error code returned from the job execution or null if job is still running or didn't return an error.\n" }, { "name": "errorMessage", "value": "", "type": "query", "description": "Error message returned from the job execution or null if job is still running or didn't return an error.\n" }, { "name": "processKey", "value": "", "type": "query", "description": "Process identifier related to the job execution." }, { "name": "externalUrl", "value": "", "type": "query", "description": "The a URL of the job for accessing this resource and its status." }, { "name": "eventKey", "value": "", "type": "query", "description": "Event that triggered the execution of this job or null." }, { "name": "dataEntityKey", "value": "", "type": "query", "description": "Unique entity key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job execution summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of job executions for a job." }, { "info": { "name": "Create a new job execution.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new job execution." }, { "info": { "name": "Get a specific job execution by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions/:jobExecutionKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "jobExecutionKey", "value": "", "type": "path", "description": "The key of the job execution." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job execution response.\n" } ] }, "docs": "Gets a specific job execution by key." }, { "info": { "name": "Returns a list of job logs.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions/:jobExecutionKey/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "jobExecutionKey", "value": "", "type": "path", "description": "The key of the job execution." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "severity", "value": "", "type": "query", "description": "Severity level for this Log." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job log summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of job logs." }, { "info": { "name": "Get a specific job log by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions/:jobExecutionKey/logs/:jobLogKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "jobExecutionKey", "value": "", "type": "path", "description": "The key of the job execution." }, { "name": "jobLogKey", "value": "", "type": "path", "description": "Unique job log key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job log response.\n" } ] }, "docs": "Gets a specific job log by key." }, { "info": { "name": "Returns a list of job metrics.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions/:jobExecutionKey/metrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "jobExecutionKey", "value": "", "type": "path", "description": "The key of the job execution." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "category", "value": "", "type": "query", "description": "Category of this metric." }, { "name": "subCategory", "value": "", "type": "query", "description": "Sub category of this metric under the category. Used for aggregating values. May be null." }, { "name": "unit", "value": "", "type": "query", "description": "Unit of this metric." }, { "name": "value", "value": "", "type": "query", "description": "Value of this metric." }, { "name": "batchKey", "value": "", "type": "query", "description": "Batch key for grouping, may be null." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeInserted", "value": "", "type": "query", "description": "The time the metric was logged or captured in the system where the job executed.\nAn [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job metric summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of job metrics." }, { "info": { "name": "Get a specific job metric by key.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/jobs/:jobKey/executions/:jobExecutionKey/metrics/:jobMetricsKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "jobKey", "value": "", "type": "path", "description": "Unique job key." }, { "name": "jobExecutionKey", "value": "", "type": "path", "description": "The key of the job execution." }, { "name": "jobMetricsKey", "value": "", "type": "path", "description": "Unique job metrics key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a job metric response.\n" } ] }, "docs": "Gets a specific job metric by key." }, { "info": { "name": "Returns a list of namespaces within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/namespaces", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a namespace summary response.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of namespaces within a data catalog." }, { "info": { "name": "Create a new Namespace to be used by a custom property", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/namespaces", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Namespace to be used by a custom property" }, { "info": { "name": "Get a specific namespace for the given key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a namespace response.\n" } ] }, "docs": "Gets a specific namespace for the given key within a data catalog." }, { "info": { "name": "Update a specific namespace identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific namespace identified by the given key." }, { "info": { "name": "Delete a specific Namespace identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." } ] }, "docs": "Deletes a specific Namespace identified by it's key." }, { "info": { "name": "Returns a list of custom properties within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId/customProperties", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "dataTypes", "value": "", "type": "query", "description": "Return the custom properties which has specified data types\n" }, { "name": "typeName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire type name given. The match is not case sensitive" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a custom property summary response.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of custom properties within a data catalog." }, { "info": { "name": "Create a new Custom Property", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId/customProperties", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Custom Property" }, { "info": { "name": "Get a specific custom property for the given key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId/customProperties/:customPropertyKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." }, { "name": "customPropertyKey", "value": "", "type": "path", "description": "Unique Custom Property key" }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a custom property response.\n" } ] }, "docs": "Gets a specific custom property for the given key within a data catalog." }, { "info": { "name": "Update a specific custom property identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId/customProperties/:customPropertyKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." }, { "name": "customPropertyKey", "value": "", "type": "path", "description": "Unique Custom Property key" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific custom property identified by the given key." }, { "info": { "name": "Delete a specific custom property identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/namespaces/:namespaceId/customProperties/:customPropertyKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "namespaceId", "value": "", "type": "path", "description": "Unique namespace identifier." }, { "name": "customPropertyKey", "value": "", "type": "path", "description": "Unique Custom Property key" } ] }, "docs": "Deletes a specific custom property identified by it's key." }, { "info": { "name": "Returns a list of patterns defined in this data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/patterns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeCreated", "value": "", "type": "query", "description": "Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "timeUpdated", "value": "", "type": "query", "description": "Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string." }, { "name": "createdById", "value": "", "type": "query", "description": "OCID of the user who created the resource." }, { "name": "updatedById", "value": "", "type": "query", "description": "OCID of the user who updated the resource." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a pattern summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of patterns within a data catalog." }, { "info": { "name": "Create a new pattern.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/patterns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new pattern." }, { "info": { "name": "Get a specific pattern for the given key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/patterns/:patternKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "patternKey", "value": "", "type": "path", "description": "Unique pattern key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a pattern response.\n" } ] }, "docs": "Gets a specific pattern for the given key within a data catalog." }, { "info": { "name": "Update a specific pattern identified by the given key.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/catalogs/:catalogId/patterns/:patternKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "patternKey", "value": "", "type": "path", "description": "Unique pattern key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific pattern identified by the given key." }, { "info": { "name": "Delete a specific pattern identified by it's key.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/catalogs/:catalogId/patterns/:patternKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "patternKey", "value": "", "type": "path", "description": "Unique pattern key." } ] }, "docs": "Deletes a specific pattern identified by it's key." }, { "info": { "name": "List the logical entities derived using this pattern usually as part of the harvest.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/patterns/:patternKey/actions/listDerivedLogicalEntities", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "patternKey", "value": "", "type": "path", "description": "Unique pattern key." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List logical entities derived from this pattern." }, { "info": { "name": "Validate the pattern based on the expression and input set of files to return file groups and logical entities", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/patterns/:patternKey/actions/validate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "patternKey", "value": "", "type": "path", "description": "Unique pattern key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate pattern by deriving file groups representing logical entities using the expression" }, { "info": { "name": "Returns a list of search results within a data catalog.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/search", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "name", "value": "", "type": "query", "description": "Immutable resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "timeout", "value": "", "type": "query", "description": "A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the\nspecified time value and bail with the hits accumulated up to that point when expired.\nDefaults to no timeout.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of search results within a data catalog." }, { "info": { "name": "Returns a list of all user created tags in the system.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/tags", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return only resources that match display name pattern given. The match is not case sensitive.\nFor Example : /folders?displayNameContains=Cu.*\nThe above would match all folders with display name that starts with \"Cu\" or has the pattern \"Cu\" anywhere in between.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a term summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all user created tags in the system." }, { "info": { "name": "Returns a list of all types within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/types", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "name", "value": "", "type": "query", "description": "Immutable resource name." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "isInternal", "value": "", "type": "query", "description": "Indicates whether the type is internal, making it unavailable for use by metadata elements." }, { "name": "isTag", "value": "", "type": "query", "description": "Indicates whether the type can be used for tagging metadata elements." }, { "name": "isApproved", "value": "", "type": "query", "description": "Indicates whether the type is approved for use as a classifying object." }, { "name": "externalTypeName", "value": "", "type": "query", "description": "Data type as defined in an external system." }, { "name": "typeCategory", "value": "", "type": "query", "description": "Indicates the category of this type . For example, data assets or connections." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a type summary response.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "Returns a list of all types within a data catalog." }, { "info": { "name": "Get a specific type by key within a data catalog.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/catalogs/:catalogId/types/:typeKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "typeKey", "value": "", "type": "path", "description": "Unique type key." }, { "name": "fields", "value": "", "type": "query", "description": "Specifies the fields to return in a type response.\n" } ] }, "docs": "Gets a specific type by key within a data catalog." }, { "info": { "name": "Associate the custom property for the given type", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/types/:typeKey/actions/associateCustomProperties", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "typeKey", "value": "", "type": "path", "description": "Unique type key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate the custom property for the given type" }, { "info": { "name": "Remove the custom property for the given type", "type": "http" }, "http": { "method": "POST", "url": "/20190325/catalogs/:catalogId/types/:typeKey/actions/disassociateCustomProperties", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "catalogId", "value": "", "type": "path", "description": "Unique catalog identifier." }, { "name": "typeKey", "value": "", "type": "path", "description": "Unique type key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove the custom property for the given type" }, { "info": { "name": "Lists all metastores in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/metastores", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment where you want to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given. The match is not case sensitive." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" } ] }, "docs": "Returns a list of all metastores in the specified compartment.\n" }, { "info": { "name": "Creates a new metastore.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/metastores", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new metastore.\n" }, { "info": { "name": "Get a metastore.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/metastores/:metastoreId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metastoreId", "value": "", "type": "path", "description": "The metastore's OCID." } ] }, "docs": "Gets a metastore by identifier." }, { "info": { "name": "Update a metastore.", "type": "http" }, "http": { "method": "PUT", "url": "/20190325/metastores/:metastoreId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metastoreId", "value": "", "type": "path", "description": "The metastore's OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a metastore resource by identifier." }, { "info": { "name": "Delete a metastore.", "type": "http" }, "http": { "method": "DELETE", "url": "/20190325/metastores/:metastoreId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metastoreId", "value": "", "type": "path", "description": "The metastore's OCID." } ] }, "docs": "Deletes a metastore resource by identifier." }, { "info": { "name": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "/20190325/metastores/:metastoreId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "metastoreId", "value": "", "type": "path", "description": "The metastore's OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource." }, { "info": { "name": "List work requests.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment where you want to list resources." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given OCID." }, { "info": { "name": "Lists work request errors.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for CODE and MESSAGE is ascending. If no value is specified TIMESTAMP is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs.", "type": "http" }, "http": { "method": "GET", "url": "/20190325/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for MESSAGE is ascending. If no value is specified TIMESTAMP is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Returns a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }