End point to create asynchronous jobs.
Data Hub
Loading...
The Data Hub API provides access to information that is managed by SAS Visual Investigator. This API facilitates describing data that resides in either internal writable databases or external customer-controlled read-only databases. Once the data definitions are provided as entity types, the data becomes accessible within SAS Visual Investigator. This API also provides mechanisms for fetching individual entity records that were defined by the entity type definitions.
Contains the operations related to data store configurations.
get
Internal-Use OnlyRetrieves a data store that matches a specific name. The user name and password for the data store (required for the Create operation) are not returned in the response.Fetch a data store by name
post
Internal-Use OnlyCreates a new data store. Prior to version 10.5.1 of SAS Visual Investigator, this process could take from 30-60 seconds to complete. The "handle" property must be generated by the client. The string must be unique and contain no special characters. The "username" and "password" properties are required.Create a data store
put
Internal-Use OnlyRepairs a data store. At times, data store information can get into a bad state. For example, during a release migration when data store metadata is being moved and a failure occurs. In these situations, use this endpoint along with the full data store content with the user name and password. Data Hub attempts to repair the state of the data store.Repair a data store
get
Internal-Use OnlyRetrieves a list of all available data stores.Fetch all data stores
head
Internal-Use OnlyRetrieves headers for the data store user name and password. Other metadata about the data store is not included in the response. This endpoint requires the "svi.administration.datastore_credentials" capability. Be careful about who is given this capability. This endpoint is designed to be used by other SAS services that need the data store credentials.Get headers for user name and password for a data store
get
Internal-Use OnlyRetrieves the data store user name and password. Other metadata about the data store is not included in the response. This endpoint requires the "svi.administration.datastore_credentials" capability. Be careful about who is given this capability. This endpoint is designed to be used by other SAS services that need the data store credentials.Fetch user name and password for a data store
post
Internal-Use OnlyAttempts to connect to the data store that is specified in the request body. This endpoint requires the "svi.administration.core_metadata" capability.Test the connection to the data store that is in the request body
get
Internal-Use OnlyRetrieves the default data store. This endpoint requires the "svi.administration.core_metadata" capability.Get the default data store
get
Internal-Use OnlyRetrieves a list of supported database types. This endpoint requires the "svi.administration.core_metadata" capability.Gets a list of supported database types
head
Internal-Use OnlyRetrieves headers for a data store that matches the specified data store ID. The user name and password for the data store (required for the Create operation) are not returned in the response. This endpoint requires the "svi.administration.core_metadata" capability.Get headers for a data store by ID
get
Internal-Use OnlyRetrieves a data store that matches the specified data store ID. The user name and password for the data store (required for the Create operation) are not returned in the response. This endpoint requires the "svi.administration.core_metadata" capability.Get a data store by ID
delete
Internal-Use OnlyDeletes the data store that matches the specified data store ID. This endpoint requires the "svi.administration.core_metadata" capability.Delete a data store by ID
put
Internal-Use OnlyUpdates the data store with the specified ID to the data store definition that is contained in the request body. This endpoint requires the "svi.administration.core_metadata" capability.Update a data store by ID
head
Internal-Use OnlyReturns headers for a list of all table names from the data store with the specified ID. This endpoint requires the "svi.administration.core_metadata" capability.Get headers for all table names from a data store
get
Internal-Use OnlyReturns a list of all table names from the data store with the specified ID. This endpoint requires the "svi.administration.core_metadata" capability.Get all table names from a data store
head
Internal-Use OnlyReturns headers for table metadata from a data store for the specified data store ID and table name. This endpoint requires the "svi.administration.core_metadata" capability.Get headers for table metadata from a data store
get
Internal-Use OnlyReturns table metadata from a data store for the specified data store ID and table name. This endpoint requires the "svi.administration.core_metadata" capability.Get table metadata from a data store
Contains the operations related to documents.
post
Internal-Use OnlyCreate a new internal document. If child documents are included in the request body, new child documents are also created.Create a new internal document
head
Internal-Use OnlyGets headers for a collection of documents for the specified entity type. To filter the collection of documents, submit a GET via POST request.Get headers for a collection of documents by entity type
get
Internal-Use OnlyGets a collection of documents for the specified entity type. To filter the collection of documents, submit a GET via POST request. Requesting a collection of child documents is not supported.Get a collection of documents by entity type
post
Internal-Use OnlyFilters a collection of documents by document ID or by using a custom filter. The type of filtering determines the media types to specify in the Content-Type header. This endpoint is a GET via POST. The reasoning for why a POST is needed is specified for each type of request.Filter a collection of documents
head
Internal-Use OnlyGets headers for a document by ID. Both internal and external documents can be read.Get headers for a document by ID
get
Internal-Use OnlyGets a document by ID. You can use a parameter to specify whether child documents are returned. Both internal and external documents can be read.Get a document by ID
put
Internal-Use OnlyUpdates an internal document. This is an appropriate way to add child documents or worksheets to the document. The content of the request is the existing document. Updating external documents is not allowed.Update an internal document
patch
Internal-Use OnlyApplies a patch to a document. This enables a client to make changes to a document without needing to load the entire document. The request body contains a description of the changes to be made to the document, which is represented by a json-patch object. For more information about json-patch, refer to jsonpatch.com.Patch a document
delete
Internal-Use OnlyDeletes an internal document. Deleting external documents is not allowed.Delete an internal document
post
Internal-Use OnlyCreates and updates internal documents in bulk. The input is a list of document objects. Each document represents either a Create or Update operation, depending on its form. The output is a list of operation summary results.Bulk create and update documents
head
Internal-Use OnlyFor a given document and relationship type name, finds all the documents that are related to the given document according to the given relationship type.Get headers for other documents related to an individual document
get
Internal-Use OnlyFor a given document and relationship type name, finds all the documents that are related to the given document according to the given relationship type.Get other documents related to an individual document
head
Internal-Use OnlyGets headers for a representation of multiple fields values for a top-level document. Since the GET operation for this endpoint does not produce an error if the user is not authorized to reveal the value of a masked field, this HEAD operation does not either.Get headers for field values for document
get
Internal-Use OnlyGets a representation of multiple fields values for a top-level document. If any of the fields is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If any of the fields are configured for masking and the requesting user is not authorized to reveal the value of the masked field, the value will be omitted from the response.Get field values for document
head
Internal-Use OnlyGets headers for a representation of a field value for a top-level document. If the field is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the request will succeed. If the field is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the request will fail.Get headers for field value for document
get
Internal-Use OnlyGets a representation of a field value for a top-level document. If the field is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If the field is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.Get field value for document
head
Internal-Use OnlyGets headers for a representation of a field value for a top-level document at a certain point in its history. If the field is currently configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the request will succeed. If the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the request will fail.Get headers for historical field value for document
get
Internal-Use OnlyGets a representation of a field value for a top-level document at a certain point in its history. If the field is currently configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.Get historical field value for document
head
Internal-Use OnlyGets headers for a representation of multiple fields values for a child document. Since the GET operation for this endpoint does not produce an error if the user is not authorized to reveal the value of a masked field, this HEAD operation does not either.Get headers for field values for child document
get
Internal-Use OnlyGets a representation of multiple fields values for a child document. If any of the fields is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If any of the fields is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the value will be omitted from the response.Get field values for child document
head
Internal-Use OnlyGets headers for a representation of a field value for a child document. If the field is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the request will succeed. If the field is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the request will fail.Get headers for field value for child document
get
Internal-Use OnlyGets a representation of a field value for a child document. If the field is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If the field is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.Get field value for child document
head
Internal-Use OnlyGets headers for a representation of a field value for a child document at a certain point in its history. If the field is currently configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the request will succeed. If the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the request will fail.Get headers for historical field value for child document
get
Internal-Use OnlyGets a representation of a field value for a child document at a certain point in its history. If the field is currently configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.Get historical field value for child document
head
Internal-Use OnlyGets headers for a summary of action history for a document. Action history summaries contain a link to fetch the full representation. The 'Accept-Item' request header can be used to fetch the available action types for this document. If the 'Accept-Item' header is set to "application/vnd.sas.investigate.action.type", this endpoint returns a collection of action types. This collection represents all of the action types that exist historically for the specified document, providing an exhaustive list of all possible filter options.Get headers for summary of action history for a document
get
Internal-Use OnlyGets a summary of action history for a document. Action history summaries contain a link to fetch the full representation. The 'Accept-Item' request header can be used to fetch the available action types for this document. If the 'Accept-Item' header is set to "application/vnd.sas.investigate.action.type", this endpoint returns a collection of action types. This collection represents all of the action types that exist historically for the specified document, providing an exhaustive list of all possible filter options.Get summary of action history for a document
head
Internal-Use OnlyGets headers for the full representation of an action from a document's action history. A link to this representation is returned in the links property of an action summary.Get headers for an action for a document
get
Internal-Use OnlyGets the full representation of an action from a document's action history. A link to this representation is returned in the links property of an action summary.Get an action for a document
head
Internal-Use OnlyGets headers for a summary of version history for a document. Version summaries contain a link to fetch the full version representation.Get headers for summary of version history for a document
get
Internal-Use OnlyGets a summary of version history for a document. Version summaries contain a link to fetch the full version representation.Get summary of version history for a document
head
Internal-Use OnlyGets headers for the full representation of a version from a document's version history. A link to this representation is returned in the links property of a version summary.Get headers for a document version
get
Internal-Use OnlyGets the full representation of a version from a document's version history. A link to this representation is returned in the links property of a version summary.Get a version for a document
head
Internal-Use OnlyGets headers for a summary of version history for a child document. Child version summaries contain a link to fetch the full child version representation.Get headers for a summary of version history for a child document
get
Internal-Use OnlyGets a summary of version history for a child document. Child version summaries contain a link to fetch the full child version representation.Get a summary of version history for a child document
head
Internal-Use OnlyGets headers for the full representation of a child version from a child document's version history. A link to this representation is returned in the "links" property of a child version summary.Get headers for a child document version
get
Internal-Use OnlyGets the full representation of a child version from a child document's version history. A link to this representation is returned in the "links" property of a child version summary.Get a child version for a child document
head
Internal-Use OnlyGets headers for additional history information about a historical document version. For example, this could be Create, Edit, and Delete operations on Insight objects associated with the document.Get headers for additional history information about a historical document version
get
Internal-Use OnlyGets additional history information about a historical document version. For example, this could be Create, Edit, and Delete operations on Insight objects associated with the document.Get additional history information about a historical document version
head
Internal-Use OnlyGets headers for additional history information for a child document at a specific parent document version.Get headers for additional history information for a child document at a specific parent document version
get
Internal-Use OnlyGets additional history information for a child document at a specific parent document version.Get additional history information for a child document at a specific parent document version
post
Internal-Use OnlyPlaces a lock on a document prior to modifying or deleting the document. If another user has a lock on the object, the request fails. Be sure to delete the lock after editing the document. A document lock times out after two hours or when the session ends; whichever occurs first.Lock a document for editing and deletion
delete
Internal-Use OnlyReleases a document lock. A document lock times out after two hours or when the session ends; whichever occurs first.Release a document lock
get
Internal-Use OnlyDetermines whether the user has a lock on a document.Query document lock for user
Contains the operations related to relationship links.
post
Internal-Use OnlyCreates a new relationship link between two documents. A link is an instance of a relationship type. A relationship type that describes the link must already exist. The relationship type must have an internal bridge table to create links.Create a new relationship link between two documents
get
Internal-Use OnlyGets either a list of links that are associated with a document or an individual link. The type of request is determined by the included query parameters. Do not mix the query parameters for both types of requests.Query a list of links or an individual link based on specific query parameters
put
Internal-Use OnlyUpdates an existing relationship link where the relationship type has an internal bridge table.Update a relationship link
get
Internal-Use OnlyRetrieves an individual link using an ID string.Query an individual link
put
Internal-Use OnlyUpdates an existing relationship link where the relationship type has an internal bridge table.Update a relationship link
patch
Internal-Use OnlyApplies a patch to a relationship link. This enables a client to make changes to a link without needing to load the entire link. The request body contains a description of changes to be made to the link, which is represented by a json-patch object. For more information about json-patch, refer to jsonpatch.com.Patch a relationship link
delete
Internal-Use OnlyDeletes an existing relationship link where the relationship type has an internal bridge table.Delete a relationship link
head
Internal-Use OnlyGets headers for a representation of multiple field values for a relationship link. Since the GET operation for this endpoint does not produce an error if the user is not authorized to reveal the value of a masked field, this HEAD operation does not either.Get headers for field values for a relationship link
get
Internal-Use OnlyGets a representation of multiple field values for a relationship link. If any of the fields is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If any of the fields are configured for masking and the requesting user is not authorized to reveal the value of the masked field, the value will be omitted from the response.Get field values for a relationship link
head
Internal-Use OnlyGets headers for a representation of a field value for a relationship link. If the field is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the request will succeed. If the field is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the request will fail.Get headers for field value for a relationship link
get
Internal-Use OnlyGets a representation of a field value for a relationship link. If the field is configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If the field is configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.Get field value for a relationship link
head
Internal-Use OnlyGets headers for a representation of a field value for a relationship link at a certain point in its history. If the field is currently configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the request will succeed. If the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the request will fail.Get headers for historical field value for a relationship link
get
Internal-Use OnlyGets a representation of a field value for a relationship link at a certain point in its history. If the field is currently configured for masking, and if the requesting user is authorized to reveal the value of the masked field, the raw unmasked value of the field is returned. If the field is currently configured for masking and the requesting user is not authorized to reveal the value of the masked field, the result is an error.Get historical field value for a relationship link
get
Internal-Use OnlyGets a summary of action history for a link. Action history summaries contain a link to fetch the full representation. The 'Accept-Item' request header can be used to fetch the 'available action types' for this link. If the 'Accept-Item' header is set to "application/vnd.sas.investigate.action.type", this endpoint returns a collection of action types. This collection represents all of the action types that exist historically for the specified link, providing an exhaustive list of all possible filter options.Get summary of action history for a link
head
Internal-Use OnlyGets headers for the full representation of an action from a link's action history. A link to this representation is returned in the links property of an action summary.Get headers for an action from the action history of a link
get
Internal-Use OnlyGets the full representation of an action from a link's action history. A link to this representation is returned in the links property of an action summary.Get an action from the action history of a link
get
Internal-Use OnlyGets a summary of version history for a link. Version summaries contain a link to fetch the full version representation.Get summary of version history for a link
head
Internal-Use OnlyGets headers for the full representation of a version from a link's version history. The link to fetch the full representation is returned with version summaries.Get headers for a version from the version history of a link
get
Internal-Use OnlyGets the full representation of a version from a link's version history. The link to fetch the full representation is returned with version summaries.Get a version from the version history of a link
post
Internal-Use OnlyCreates and Updates internal links in bulk. The input is a list of link objects. Each link represents either a Create or Update operation, depending on its form. The output is a list of operation summary results. The input for the request is a SAS collection, which looks like the following:Bulk Create and Update links
get
Internal-Use OnlyFor a given entityTypeName and entityId, searches for all related entities and returns a summary of the total number of links found for each related entity type. This method finds all links that are related to an entity and from an entity.Retrieve a count of the number of links between an entity and its related entities
Contains the operations related to managing entity type metadata.
get
Internal-Use OnlyRetrieves an entity type by name. An entity type is the metadata that is associated with documents.Retrieve an entity type object by name
head
Internal-Use OnlyRetrieves headers for an entity type by ID. An entity type is the metadata that is associated with documents.Retrieve headers for an entity type object by ID
get
Internal-Use OnlyRetrieves an entity type by ID. An entity type is the metadata that is associated with documents.Retrieve an entity type object by ID
get
Internal-Use OnlyRetrieves all entity types in the full representation.Retrieve all entity types
get
Internal-Use OnlyRetrieves all entity types where each object is a summary representation of the entity type.Retrieve all entity types in a summary representation
post
Internal-Use OnlySynchronizes an entity type's field metadata with the schema for the database table that contains the entity type's records. This can be used to repair the entity type's metadata if the table that backs the entity type changes. Care should be taken when using this operation as it does not automatically update other services in SAS Visual Investigator to reflect the metadata changes. Users who do not understand how their metadata is used in SAS Visual Investigator or are not prepared to repair inconsistencies downstream from Data Hub are not advised to use this endpoint. The request body should be empty.Trigger entity type metadata reconstruction
Contains the operations related to managing reference list metadata.
get
Internal-Use OnlyFetches all reference lists or a single reference list by specifying the name of the list.Fetch all reference list or lists
post
Internal-Use OnlyCreates a new reference list.Create a new reference list
put
Internal-Use OnlyUpdates a reference list by ID.Update a reference list
Contains the operations related to managing relationship type metadata.
get
Internal-Use OnlyDepending on the query parameter used, returns either a single relationship by qualified name or all relationships of a given type. Using both query parameters in a single request is not supported. Use the "qualifiedName" parameter when the looking up an individual relationship by its qualified name. The qualified name can be determined from the "qualifiedName" property in the relationship type or by constructing one. Use the "type" parameter when looking up all relationships of a given type.Fetch a single relationship type or an array of relationship types
post
Internal-Use OnlySynchronizes the relationship type's field metadata with the schema for the database table that contains the relationship type's records. This can be used to repair the relationship type's metadata if the table that backs the relationship type changes. Care should be taken when using this operation as it does not automatically update other services in SAS Visual Investigator to reflect the metadata changes. Users who do not understand how their metadata is used in SAS Visual Investigator or are not prepared to repair inconsistencies downstream from Data Hub are not advised to use this endpoint. The request body should be empty.Trigger relationship type metadata reconstruction
Contains the operations related to managing solution metadata.
Contains the operations related to managing transaction type metadata.
get
Internal-Use OnlyRetrieves a transaction type object by name. Transaction types are metadata describing transaction links.Retrieve a transaction type by name
head
Internal-Use OnlyRetrieves headers for a transaction type object by ID. Transaction types are metadata that describe transaction links.Retrieve headers for a transaction type object by ID
get
Internal-Use OnlyRetrieves a transaction type object by ID. Transaction types are metadata that describe transaction links.Retrieve a transaction type object by ID
get
Internal-Use OnlyRetrieves all transaction types. Transaction types are metadata that describe transaction links.Retrieve all transaction types
post
Internal-Use OnlySynchronizes the transaction type's field metadata with the schema for the database table that contains the transaction type's records. This can be used to repair the transaction type's metadata if the table that backs the transaction type changes. Care should be taken when using this operation as it does not automatically update other services in SAS Visual Investigator to reflect the metadata changes. Users who do not understand how their metadata is used in SAS Visual Investigator or are not prepared to repair inconsistencies downstream from Data Hub are not advised to use this endpoint. The request body should be empty.Trigger transaction type metadata reconstruction
Contains the operations related to attachments.
head
Internal-Use OnlyGets headers for all file attachment metadata that is associated with a document. The "location" property in the response contains the relative URI path to the document. To retrieve the contents of an attachment, use that URI to download the document from the Files service: GET ${hostAndPort}${valueOfLocationProperty} .Get headers for all file attachment metadata associated with a document
get
Internal-Use OnlyThe "location" property in the response contains the relative URI path to the document. To retrieve the contents of an attachment, use that URI to download the document from the Files service: GET ${hostAndPort}${valueOfLocationProperty} .Get all file attachment metadata associated with a document
post
Internal-Use OnlyCreates file attachment metadata on a document. To create an attachment, upload the file to the SAS Viya Files service, and then use the Files service response to construct a request to the Data Hub createDocumentAttachment endpoint.Create file attachment metadata on a document
head
Internal-Use OnlyGets headers for the file attachment metadata that is associated with a document. The "location" property is the relative URI path to download the document from the Files service. To retrieve the contents of an attachment, use the URI that is provided in the "location" field: GET ${hostAndPort}${valueOfLocationProperty} .Get headers for file attachment metadata associated with a document
get
Internal-Use OnlyGets the file attachment metadata that is associated with a document. The "location" property is the relative URI path to download the document from the Files service. To retrieve the contents of an attachment, use the URI that is provided in the "location" field: GET ${hostAndPort}${valueOfLocationProperty} .Get file attachment metadata associated with a document
delete
Internal-Use OnlyDeletes an attachment that is associated with a document. The metadata and the file that are stored by the Files service are deleted.Delete an attachment from a document
Contains the operations related to administering the service.
Contains the operations related to comments.
head
Internal-Use OnlyGets headers for a collection of comments by object type and ID.Get headers for a collection of comments associated with an object
get
Internal-Use OnlyGets a collection of comments by object type and ID.Get a collection of comments associated with an object
post
Internal-Use OnlyCreates a new comment for the specified object type and object ID.Create a new comment
put
Internal-Use OnlyUpdates a comment on an object by specifying the object type and ID. During an Update operation, all properties of a comment are read-only except the category. This is for security and audit purposes in order to keep historical data accurate.Update a comment
head
Internal-Use OnlyGets headers for a collection of comment category summaries by object type and ID.Get headers for a collection of comment category summaries that are associated with an object
get
Internal-Use OnlyGets a collection of comment category summaries by object type and ID.Get a collection of comment category summaries that are associated with an object
Contains the operations related to files.
post
Internal-Use OnlyCreates a file association. You can create a file association by using the representation that is contained in the request body or by reusing a file that is already associated with an object. To create a file association using the representation that is contained in the request body, the file to which the file association points (via its Location property) must exist in the Files service and must not be associated with another object. To create a file association by using a file that is already associated with an object, call this endpoint without a request body and use the copyFileFrom parameter to identify the file. The Data Hub service copies the file enabling it to be associated with a different object. The object that is identified by the objectTypeName and objectId in the path is associated with the copied file.Create a file association object and associate it with an object
head
Internal-Use OnlyGets headers for the files that are associated with an object and returns them as a collection.Get headers for the files that are associated with an object
get
Internal-Use OnlyGets the files that are associated with an object and returns them as a collection.Get the files that are associated with an object
head
Internal-Use OnlyGets headers for the file metadata for the file with the specified object type, object type ID, and file ID.Get headers for file metadata
get
Internal-Use OnlyGets the file metadata for the file with the specified object type, object type ID, and file ID.Get file metadata
put
Internal-Use OnlyUpdates the file metadata for the file with the specified object type, object type ID, and file ID. You can update the following fields: name, description, displayOrder and properties. If the file association is a link to an external file, you can also update the extractedContent field. Updates to any other fields are ignored.Update the file association object with the specified file ID
delete
Internal-Use OnlyDeletes the file with the specified ID from the object that is specified in the path.Delete the file with the specified file ID
head
Internal-Use OnlyGets the headers when downloading the file with the specified ID from the object that is specified in the path.Gets headers when downloading the file with the specified file ID
get
Internal-Use OnlyDownloads the file with the specified ID from the object that is specified in the path.Download the file with the specified file ID
head
Internal-Use OnlyGets the headers when downloading the file with the specified ID, for a file that is not attached to an object. Use the /documents/{objectTypeName}/{objectId}/files/{fileId}/content endpoint for a file that is attached to an object.Gets headers for downloading the detached file with the specified file ID
get
Internal-Use OnlyDownloads the file with the specified ID, for a file that is not attached to an object. Use the /documents/{objectTypeName}/{objectId}/files/{fileId}/content endpoint for a file that ißs attached to an object.Download the detached file with the specified file ID
delete
Internal-Use OnlyDeletes the file with the specified ID, if it is not attached to an object. Use the /documents/{objectTypeName}/{objectId}/files/{fileId} endpoint if the file is attached to an object.Delete the file with the specified file ID
head
Internal-Use OnlyGets headers for the files that are associated with a child object and returns them as a collection.Get headers for the files that are associated with a child object
get
Internal-Use OnlyGets the files that are associated with a child object and returns them as a collection.Get the files that are associated with a child object
get
Internal-Use OnlyDownloads the file with the specified ID from the child object that is specified in the path.Download a file associated with a child object
head
Internal-Use OnlyGets the headers when downloading the file with the specified ID from the child object that is specified in the path.Get headers when downloading a file associated with a child object
Contains the operations related to sheets.
head
Internal-Use OnlyGets headers for a list of the sheets that are associated with the object specified in the path. To modify a sheet, update the sheets property on the object using a separate endpoint.Get headers for a list of sheets by object type and object ID
get
Internal-Use OnlyGets a list of the sheets that are associated with the object specified in the path. To modify a sheet, update the sheets property on the object using a separate endpoint.Get a list of sheets by object type and object ID
post
Internal-Use OnlyThe sheet copy selection included in the request body is used to copy the sheets from their location. The sheets are copied to the object specified in the path. The object to which the sheets were copied is returned as an enriched document.Copy selected sheets to the provided object
head
Internal-Use OnlyGets headers for the sheet with the given ID from the object that is specified in the path. To modify a sheet, update the sheets property on the object using a separate endpoint.Get headers for a sheet
get
Internal-Use OnlyGets a sheet with the given ID from the object that is specified in the path. To modify a sheet, update the sheets property on the object using a separate endpoint.Get a sheet
Contains the operations related to icons.
get
Internal-Use OnlyRetrieves metadata for one or more icons.Retrieve metadata for one or more icons
head
Internal-Use OnlyRetrieves an icon's metadata by name. Icon metadata contains information about an image.Request header for icon metadata by object type name
get
Internal-Use OnlyRetrieves an icon's metadata by name. Icon metadata contains information about an image.Retrieve icon metadata by name
head
Internal-Use OnlyRetrieves an icon's metadata by name. Icon metadata contains information about an image.Request header for icon metadata by name
get
Internal-Use OnlyRetrieves the bytes comprising an icon image.Retrieve an icon image by name
head
Internal-Use OnlyRetrieves the bytes comprising an icon image.Request header for an icon image by name
get
Internal-Use OnlyRetrieves the bytes comprising an icon image.Retrieve an icon image by filter
head
Internal-Use OnlyRetrieves the bytes comprising an icon image.Request header for an icon image by filter
get
Internal-Use OnlyRetrieves a node decorator for an Entity or Document.Retrieve the decoration for an icon
head
Internal-Use OnlyRetrieves a node decorator for an Entity or Document.Request header for the decoration for an icon
Contains the operations related to conditions.