Namespace Autodesk.DataManagement.Model
Classes
BaseAttributesExtensionObjectWithSchemaLink
A container of additional properties that extends this resource.
BaseAttributesExtensionObjectWithSchemaLinkSchema
A container for the hyperlink to the schema of the type.
BaseAttributesExtensionObjectWithoutSchemaLink
A container of additional properties that extends this resource.
The data
object returned by the CheckPermission command.
Contains the properties of the response to the CheckPermission command.
CheckPermissionAttributesExtension
An object that contains properties specific to the CheckPermissions command, extending the default properties of a command.
CheckPermissionAttributesExtensionData
A container of the results of the resources that were checked for permission.
CheckPermissionAttributesExtensionDataPermissions
CheckPermissionAttributesExtensionDataPermissions
CheckPermissionAttributesExtensionDataPermissionsDetails
An object containing key value pairs, where the key represents the type of permission that was checked and the value is true
if the user has permission.
CheckPermissionAttributesExtensionSchema
Contains the location of the schema.
An object that contains the input data required to execute the CheckPermission command. The CheckPermission command checks if a user has permission to perform specified actions on specified resources. The user’s identity is derived from the x-user-id
parameter (in a 2-Legged call), or from the access token (in a 3-Legged call). See the Developer’s Guide topic on the CheckPermission command for more information.
CheckPermissionPayloadAttributes
A container of the inputs for the command.
CheckPermissionPayloadAttributesExtension
An object that contains properties specific to the CheckPermission command, extending the default properties of a command.
CheckPermissionPayloadAttributesExtensionData
Contains the properties specific to the CheckPermission command.
CheckPermissionPayloadRelationships
Contains a list of resources required for execution of the command.
CheckPermissionPayloadRelationshipsResources
Contains the list of resources that permission must be checked for.
CheckPermissionPayloadRelationshipsResourcesData
CheckPermissionPayloadRelationshipsResourcesData
Contains the list of resources checked for permission.
CheckPermissionRelationshipsResources
Contains the list of resources checked for permission.
CheckPermissionRelationshipsResourcesData
CheckPermissionRelationshipsResourcesData
Commamd response
Command Payload
An object that represents the response to a Create Download request.
CreatedDownloadData
Contains the properties that indicate the current status of the job.
Create item response
The object containing the information on the command ID of the command processor.
The payload returned upon successful creation of a new version.
A container of data describing the version.
CreatedVersionIncluded
Contains the links to use to access references of this resource.
CreatedVersionIncludedRelationships
Contains links to resources that are directly related to this item.
An object that represents a download.
A container of the details of the download object.
The properties of the download.
A container of the file format of the download.
Contains links to the resources directly related to the download.
DownloadDataRelationshipsStorage
Contains information about the location of the download.
DownloadDataRelationshipsStorageData
Contains information about the storage location of the download.
DownloadDataRelationshipsStorageMeta
Meta information about the storage location of the download.
Successful retrieval of the available download formats for a specific version.
Contains information about the file formats the version can be downloaded as.
Contains the list of formats.
DownloadFormatsDataAttributesFormats
DownloadFormatsDataAttributesFormats
The payload for creating a download of a specified format.
Contains information about the desired download format and the version of the item to convert to this format.
Contains information about the desired download format.
DownloadPayloadDataAttributesFormat
Specifies the desired download format.
DownloadPayloadDataRelationships
Contains information about the version the download format is being created for.
DownloadPayloadDataRelationshipsSource
Contains information about the version the download format is being created for.
DownloadPayloadDataRelationshipsSourceData
Contains information about the version the download format is being created for.
Successful retrieval of the available downloads collection associated with a specific version.
An object that represents a folder.
FolderAttributesWithExtensions
The properties of a folder.
Successful retrieval of the folder contents collection associated with a specific folder.
Information on links for this resource. first
, prev
, and next
are available only when the response is paginated.
A container of data describing a folder.
Contains links to resources that are directly related to this folder.
A container of additional properties that extends the default properties of this resource.
Describe the folder to be created.
The data that describes the folder to be created.
The properties of the folder to be created.
FolderPayloadDataAttributesExtension
A container of additional properties that extends the default properties of this resource.
FolderPayloadDataRelationships
A container of links to resources that are related to the folder to be created.
FolderPayloadDataRelationshipsParent
Information about the parent of the new folder in the folder hierarchy.
FolderPayloadDataRelationshipsParentData
The data about the parent of the folder to be created.
FolderRefs
An object representing a hub.
The object containing information about the hub.
The properties of the hub.
Contains links to resources that are directly related to this hub.
HubDataRelationshipsPimCollection
Information on the id
and type
properties of a resource. This is available only for Fusion Team hubs and A360 Personal hubs.
Contains the endpoint you can use to list the projects in this hub.
Successful retrieval of the hubs collection.
An object that represents an item.
Properties of an item.
A container of data describing an item.
Contains links to resources that are directly related to this item.
A container of additional properties that extends the default properties of this resource.
Describe the item to be created.
The data that describes the item to be created.
The properties of the item to be created.
ItemPayloadDataAttributesExtension
The Type ID of the schema that defines the structure of the extension.data
object
A container of links to resources that are related to the item to be created.
ItemPayloadDataRelationshipsParent
Information about the parent of the new item in the folder hierarchy.
ItemPayloadDataRelationshipsParentData
The data about the parent folder.
ItemPayloadDataRelationshipsTip
Information about the first version of the new item, which will be its tip version.
ItemPayloadDataRelationshipsTipData
The data about the version to be created.
ItemPayloadIncluded
The properties of the first version of the item to be created.
ItemPayloadIncludedAttributesExtension
A container of additional properties that extends the default properties of this resource.
ItemPayloadIncludedRelationships
A container of links to resources that are related to the item to be created.
ItemPayloadIncludedRelationshipsStorage
The object containing information on where the binary data of the item is stored.
ItemPayloadIncludedRelationshipsStorageData
The data about the location of binary data.
An object that represents the tip version of an item.
An object that is returned by a successfully completed job.
Contains information about the download creation job.
Contains the properties that indicate the current status of the job.
An object containing the hyperlink to the referenced resource.
Contains the endpoint you can use to retrieve the related resources.
An object containing the endpoint to retrieve a list of related resources.
An object containing the URI of the endpoint to access this resource.
Information on links to this resource.
An object containing the URI of the endpoint to access this resource.
Meta-information on links to this resource.
JsonApiRelationshipsLinksFolderParent
Information on the parent of this resource in the folder hierarchy.
JsonApiRelationshipsLinksInternal
Information on resources that are found under this resource.
JsonApiRelationshipsLinksInternalResource
Information on the resources above this resource in the hierarchy.
JsonApiRelationshipsLinksLinks
Information on the link resources found in this resource.
JsonApiRelationshipsLinksLinksLinks
The object containing information on links to this resource.
JsonApiRelationshipsLinksOnlyBim
Contains links to resources that are external to the data domain service. This is available only with BIM360.
Information on other resources that have a custom relationship with this resource.
JsonApiRelationshipsLinksRefsLinks
The object containing information on links of related resources that share a custom relationship with this resource.
JsonApiRelationshipsLinksRootFolder
Information about the root folder of a project.
JsonApiRelationshipsLinksToTipVersion
Information about the latest version of the item.
JsonApiRelationshipsLinksVersions
Information about the existing versions of the item.
Information on other resources that share a custom relationship with this resource.
JsonApiRelationshipsRefsData
JsonApiRelationshipsRefsDataMeta
The meta-information describing the custom relationship.
JsonApiRelationshipsRefsDataMetaExtension
A container of additional properties that extends the default properties of this resource.
JsonApiRelationshipsRefsDataMetaExtensionData
The container of the additional properties. The additional properties must follow the schema specified by extensions.type
and extensions.version
. Properties that don’t follow the schema will be ignored.
An object containing the id
and type
properties of a resource.
The JSON API object.
The data
object returned by the ListItems command.
Contains the properties of the response to the ListItems command.
An object that contains properties specific to the ListItems command, extending the default properties of a command.
An object that contains the input data required to execute the ListItems command. The ListItems command retrieves metadata for up to 50 specified items. For example, an item name, or the date it was created. It also returns the tip (latest) version of the items.
A container of the inputs for the command.
ListItemsPayloadAttributesExtension
An object that contains properties specific to the ListItems command, extending the default properties of a command.
ListItemsPayloadAttributesExtensionData
Contains the custom properties specific to the ListItems command.
Contains a list of resources required for execution of the command.
ListItemsPayloadRelationshipsResources
Contains the list of items to check. The list can contain up to 50 versions.
ListItemsPayloadRelationshipsResourcesData
ListItemsPayloadRelationshipsResourcesData
Contains the list of items that were checked.
ListItemsRelationshipsResources
Contains the list of items that were checked.
ListItemsRelationshipsResourcesData
ListItemsRelationshipsResourcesData
The data
object returned by the ListItems command.
ListItemsTestRelationships
ListItemsTestRelationshipsResources
ListItemsTestRelationshipsResources
ListItemsTestRelationshipsResourcesData
ListItemsTestRelationshipsResourcesData
The data
object returned by the ListRefs command.
Contains the properties of the response to the ListRefs command.
An object that contains the input data required to execute the ListRefs command. The ListRefs command retrieves the custom relationships between specified versions of items and other resources in the data domain service (folders, items, and versions). You can retrieve the relationships of up to 50 versions.
A container of the inputs for the command.
ListRefsPayloadAttributesExtension
An object that contains properties specific to the ListRefs command, extending the default properties of a command.
Contains a list of resources required for execution of the command.
ListRefsPayloadRelationshipsResources
Contains the list of versions to check. The list can contain up to 50 versions.
ListRefsPayloadRelationshipsResourcesData
ListRefsPayloadRelationshipsResourcesData
Contains the list of versions that were checked.
ListRefsRelationshipsResources
Contains the list of versions that were checked.
ListRefsRelationshipsResourcesData
ListRefsRelationshipsResourcesData
Meta information required for webhooks.
Metadata on the resources referenced by this resource.
An object that represdents a version.
Modifies folder names
The data that describes what must be modified.
ModifyFolderPayloadDataAttributes
The properties of the folder that can be modified.
ModifyFolderPayloadDataRelationships
Contains links to resources that are directly related to this folder.
ModifyFolderPayloadDataRelationshipsParent
Information about the parent folder of this folder.
ModifyFolderPayloadDataRelationshipsParentData
A container for the data that defines the parent of this folder.
An object that defines the attributes of an item that must be updated.
The data that describes what must be modified.
ModifyItemPayloadDataAttributes
A container of the attributes to be updated.
An object that contains the information on the version to be patched.
Contains the information to update
ModifyVersionPayloadDataAttributes
Contains the properties to update
An object that is returned with responses that can be split across multiple pages. “Next,” “Previous,” and “First” are available only if the response is split across multiple pages.
A container for the link to the first page of the response.
A container for the link to the next page of the response.
A container for the link to the previous page of the response.
A container for the link to the current page of the response.
An object that represents a project.
A container of data describing a project.
The properties of the project.
Contains links to resources related to this project.
ProjectDataRelationshipsTopFolders
Information about the highest level folders you have access to.
ProjectExtensionWithSchemaLink
A container of additional properties that extends the default properties of this resource.
An object representing a collection of projects within a hub.
The data
object returned by the PublishModel command.
Contains the properties of the response to the PublishModel command.
PublishModelAttributesExtension
An object that contains properties specific to the PublishModel command, extending the default properties of a command.
The data
object returned by the GetPublishModelJob command, if the model needs publishing. If the model is already published, the data
object will be null
.
Contains the properties of the response to the GetPublishModelJob command.
PublishModelJobAttributesExtension
An object that contains properties specific to the GetPublishModelJob command, extending the default properties of a command.
An object that contains the input data required to execute the GetPublishModelJob command. The ListRefs verifies whether a Collaboration for Revit (C4R) model needs to be published to BIM 360 Docs. For more information, see the GetPublishModelJob topic in the overview section .
PublishModelJobPayloadAttributes
A container of the inputs for the command.
PublishModelJobPayloadAttributesExtension
An object that contains properties specific to the GetPublishModelJob command, extending the default properties of a command.
PublishModelJobPayloadRelationships
Contains a list of resources required for execution of the command.
PublishModelJobPayloadRelationshipsResources
Contains the list of items to check.
PublishModelJobPayloadRelationshipsResourcesData
PublishModelJobPayloadRelationshipsResourcesData
An object that contains the input required to execute the PublishModel command. The PublishModel Command publishes the latest version of a Collaboration for Revit (C4R) model to BIM 360 Docs. See the Developer’s Guide topic on the PublishModel command for more information.
A container of the inputs for the command.
PublishModelPayloadAttributesExtension
An object that contains properties specific to the PublishModel command, extending the default properties of a command.
PublishModelPayloadRelationships
Contains a list of resources required for execution of the command.
PublishModelPayloadRelationshipsResources
Contains the list of resources to be published.
PublishModelPayloadRelationshipsResourcesData
PublishModelPayloadRelationshipsResourcesData
The data
object returned by the PublishWithoutLinks command.
Contains the properties of the response to the PublishWithoutLinks command.
PublishWithoutLinksAttributesExtension
An object that contains properties specific to the PublishWithoutLinks command, extending the default properties of a command.
An object that contains the input data to execute the PublishWithoutLinks command. The PublishWithoutLinks command publishes the latest version of a Collaboration for Revit (C4R) model without the links it contains to BIM 360 Docs. See the Developer’s Guide topic on the PublishWithoutLinks command for more information.
PublishWithoutLinksPayloadAttributes
A container of the inputs for the command.
PublishWithoutLinksPayloadAttributesExtension
An object that contains properties specific to the PublishWithoutLinks command, extending the default properties of a command.
PublishWithoutLinksPayloadRelationships
Contains a list of resources required for execution of the command.
PublishWithoutLinksPayloadRelationshipsResources
Contains the list of resources to be published.
PublishWithoutLinksPayloadRelationshipsResourcesData
PublishModelPayloadRelationshipsResourcesData
Successful retrieval of a resource collection.
An object containing relationship links of a resource.
RelationshipLinksData
The meta-information of the links of this resource.
The object containing meta-information on the data of the links of this resource.
RelationshipRefs
RelationshipRefsData
An object that describes the custom relationship to be created.
A container for the data that describes the custom relationship.
RelationshipRefsPayloadDataMeta
The meta-information about this resource.
Successful retrieval of the search results.
An object representing a storage location.
An object containing information on the storage location.
Contains links to resources that are directly related to the storage location.
StorageDataRelationshipsTarget
Information about the target object.
StorageDataRelationshipsTargetData
Contains information about the folder containing the item or version the storage location is reserved for.
An object representing a placeholder (storage location) for data.
A container of data describing a storage location.
Properties of the storage location to be created.
StoragePayloadDataRelationships
Contains information on other resources related to this resource.
StoragePayloadDataRelationshipsTarget
Information about the target object.
StoragePayloadDataRelationshipsTargetData
Contains information about the resources related to the item or version the storage location will contain.
TopFolderAttributesWithExtensions
The properties of a folder.
An object containing information about a top-level folder.
TopFolderDataRelationships
TopFolderExtensionWithSchemaLink
A container of additional properties that extends the default properties of this resource.
An object that reporesents a top-level folder.
The properties of a version.
A container of data describing a version.
Contains information on other resources related to this resource.
VersionDataRelationshipsDerivatives
Contains information you can use to retrieve the derivatives of this version.
VersionDataRelationshipsDownloadFormats
Contains the endpoint you can use to find out what formats the version can be downloaded as.
Contains information about the item this is a version of.
VersionDataRelationshipsStorage
Contains information about the storage location that contains the binary data of this version.
VersionDataRelationshipsThumbnails
Contains the information required to retrieve thumbnails of this version from the Model Derivative service.
VersionExtensionWithSchemaLink
A container of additional properties that extends the default properties of a version.
Describe the version to be created.
The data that describes the version to be created.
The properties of the version to be created.
VersionPayloadDataAttributesExtension
A container of additional properties that extends the default properties of the version to be created.
VersionPayloadDataRelationships
A container of links to resources that are related to the version to be created.
VersionPayloadDataRelationshipsItem
Contains information about the item this is a version of.
VersionPayloadDataRelationshipsItemData
A container of data on the item.
VersionPayloadDataRelationshipsRefs
Information on other resources that will share a custom relationship with the version being created.
VersionPayloadDataRelationshipsRefsData
VersionPayloadDataRelationshipsRefsData
VersionPayloadDataRelationshipsRefsDataMeta
Contains meta information about the reference.
VersionPayloadDataRelationshipsRefsDataMetaExtension
Contains additional properties that extend the default properties of the relationship.
VersionPayloadDataRelationshipsRefsDataMetaExtensionData
VersionPayloadDataRelationshipsRefsDataMetaExtensionData
VersionPayloadDataRelationshipsStorage
Contains the information about the storage location that contains the binary data of this version.
VersionPayloadDataRelationshipsStorageData
A container of data on the storage location.
Successful retrieval of the versions collection associated with a specific item.
An object containing a link that opens the resource in a browser.
Interfaces
Enums
The current stage of the command execution process. Possible values:
accepted
- The command is ready to be executed.committed
- The command is currently being executed.complete
- The command was successfully executed.failed
- There was an error and command execution was stopped prematurely.
A status indicating whether this version conforms to its parent folder’s file naming standard.
Possible values:
NONE
: The conforming status is not applicable for the version.CONFORMING
: The version conforms to its parent folder’s file naming standard.NON_CONFORMING
: The version does not conform to its parent folder’s file naming standard.
In the event of a NON_CONFORMING
status, use the Get a Folder operation to get the file naming standards IDs that have been applied to the version’s parent folder. Then use the ID to call GET naming-standards to get the details of the file naming standard.
Note that this feature is only available for BIM 360 projects.
To learn more about the file naming standard feature, see the BIM 360 File Naming Standard help documentation.
The type of this resource. Possible values: queued, finished, failed, processing
The type of the relationship. Will always be xrefs:autodesk.core:Xref
.
Filter by the direction of the reference. Possible values: from
and to
.
Filter by refType
. Possible values: derived
, dependencies
, auxiliary
, xrefs
, and includes
.
Filter by the type of the objects in the folder. Supported values are folders
and items
.
Filter by the type
of the ref
target. Supported values include folders
, items
, and versions
.
The version of JSON API. Will always be 1.0
.
Describes the direction of data flow in the relationship. Possible values are:
to
- Data flows from this resource to the related resource.from
- Data flows from the related resource to this resource.
The type of the xref, which defines how nested xrefs are handled. Possible values are:
attachment
: Nested xrefs are not ignored.overlay
: Nested xrefs are ignored.
The type of project. Only relevant for BIM 360 and ACC projects.
The type of custom relationship. Will always be xrefs
.
Specifies where the hub is stored. Possible values are:
US
- Data center for the US region.EMEA
- Data center for the European Union, Middle East, and Africa regions.APAC
- Data center for the Australia region.
The type of this resource. Possible values are commands
.
TypeCommandtypeCheckPermission
The Type ID of the schema used for extending properties. Must be commands:autodesk.core:CheckPermission
for the CheckPermission command.
TypeCommandtypeGetPublishModelJob
The Type ID of the schema used for extending properties. Must be commands:autodesk.bim360:C4RModelGetPublishJob
for the GetPublishModelJob command.
The Type ID of the schema used for extending properties. Must be commands:autodesk.core:ListItems
for the ListItems command.
The Type ID of the schema used for extending properties. Must be commands:autodesk.core:ListRefs
for the ListRefs command.
TypeCommandtypePublishWithoutLinks
The Type ID of the schema used for extending properties. Must be commands:autodesk.bim360:C4RPublishWithoutLinks
for the PublishWithoutLinks command.
The Type ID of the schema used for extending properties. Must be commands:autodesk.bim360:C4RModelPublish
for the PublishModel command.
The type of this resource. Possible values are downloadFormats
.
The type of this resource. Possible values are downloads
.
The type of the resource. Possible values are folders
, items
, versions
.
The type of the resource. Possible values are folders
.
The type of the resource. Possible values are folders
, items
.
The type of resource the storage location is related to. Possible values are:
folders
- The storage location is for a new item.items
- The storage location is for a new version of an existing item.
The type of the resource. Possible values are hubs
.
The type of the resource. Possible values are items
.
The type of this resource. Possible values are jobs
.
The type of the resource. Possible values are links
.
The type of this resource. Possible values are objects
.
The type of the resource. Possible values are projects
.
The type of the resource. Possible values are derived
, dependencies
, auxiliary
, xrefs
, and includes
.
The type of the resource. Possible values are versions
.