Module: index

The Forge Platform contains an expanding collection of web service components that can be used with Autodesk cloud-based products or your own technologies. Take advantage of Autodesk’s expertise in design and engineering..
The index module provides access to constructors for all the classes which comprise the public API.

An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:

const ForgeSdk = require('index'); // See note below*.
const xxxSvc = new ForgeSdk.XxxApi(); // Allocate the API class we're going to use.
const yyyModel = new ForgeSdk.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
const zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...
*NOTE: For a top-level AMD script, use require(['index'], function(){...}) and put the application logic within the callback function.

A non-AMD browser application (discouraged) might do something like this:

const xxxSvc = new ForgeSdk.XxxApi(); // Allocate the API class we're going to use.
const yyy = new ForgeSdk.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
const zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...

Source:

Members

(static) ApiClient

The ApiClient constructor.

Properties:
Type Description
module:ApiClient
Source:

(static) AuthClientThreeLegged

The AuthClient service constructor for 3-legged flow.

Properties:
Type Description
module:auth/OAuth2ThreeLegged
Source:

(static) AuthClientTwoLegged

The AuthClient service constructor for 2-legged flow.

Properties:
Type Description
module:auth/OAuth2TwoLegged
Source:

(static) BadInput

The BadInput model constructor.

Properties:
Type Description
module:model/BadInput
Source:

(static) BaseAttributesCreatedUpdated

The BaseAttributesCreatedUpdated model constructor.

Properties:
Type Description
module:model/BaseAttributesCreatedUpdated
Source:

(static) BaseAttributesCreatedUpdatedAttributes

The BaseAttributesCreatedUpdatedAttributes model constructor.

Properties:
Type Description
module:model/BaseAttributesCreatedUpdatedAttributes
Source:

(static) BaseAttributesExtensionObject

The BaseAttributesExtensionObject model constructor.

Properties:
Type Description
module:model/BaseAttributesExtensionObject
Source:

The BaseAttributesExtensionObjectWithoutSchemaLink model constructor.

Properties:
Type Description
module:model/BaseAttributesExtensionObjectWithoutSchemaLink
Source:

(static) Bucket

The Bucket model constructor.

Properties:
Type Description
module:model/Bucket
Source:

(static) BucketObjects

The BucketObjects model constructor.

Properties:
Type Description
module:model/BucketObjects
Source:

(static) Buckets

The Buckets model constructor.

Properties:
Type Description
module:model/Buckets
Source:

(static) BucketsApi

The BucketsApi service constructor.

Properties:
Type Description
module:api/BucketsApi
Source:

(static) BucketsItems

The BucketsItems model constructor.

Properties:
Type Description
module:model/BucketsItems
Source:

(static) CommandsApi

The CommandsApi service constructor.

Properties:
Type Description
module:api/CommandsApi
Source:

(static) Conflict

The Conflict model constructor.

Properties:
Type Description
module:model/Conflict
Source:

(static) CreateItem

The CreateItem model constructor.

Properties:
Type Description
module:model/CreateItem
Source:

(static) CreateItemData

The CreateItemData model constructor.

Properties:
Type Description
module:model/CreateItemData
Source:

(static) CreateItemDataRelationships

The CreateItemDataRelationships model constructor.

Properties:
Type Description
module:model/CreateItemDataRelationships
Source:

(static) CreateItemDataRelationshipsTip

The CreateItemDataRelationshipsTip model constructor.

Properties:
Type Description
module:model/CreateItemDataRelationshipsTip
Source:

(static) CreateItemDataRelationshipsTipData

The CreateItemDataRelationshipsTipData model constructor.

Properties:
Type Description
module:model/CreateItemDataRelationshipsTipData
Source:

(static) CreateItemIncluded

The CreateItemIncluded model constructor.

Properties:
Type Description
module:model/CreateItemIncluded
Source:

(static) CreateItemRelationships

The CreateItemRelationships model constructor.

Properties:
Type Description
module:model/CreateItemRelationships
Source:

(static) CreateItemRelationshipsStorage

The CreateItemRelationshipsStorage model constructor.

Properties:
Type Description
module:model/CreateItemRelationshipsStorage
Source:

(static) CreateItemRelationshipsStorageData

The CreateItemRelationshipsStorageData model constructor.

Properties:
Type Description
module:model/CreateItemRelationshipsStorageData
Source:

(static) CreateRef

The CreateRef model constructor.

Properties:
Type Description
module:model/CreateRef
Source:

(static) CreateRefData

The CreateRefData model constructor.

Properties:
Type Description
module:model/CreateRefData
Source:

(static) CreateRefDataMeta

The CreateRefDataMeta model constructor.

Properties:
Type Description
module:model/CreateRefDataMeta
Source:

(static) CreateStorage

The CreateStorage model constructor.

Properties:
Type Description
module:model/CreateStorage
Source:

(static) CreateStorageData

The CreateStorageData model constructor.

Properties:
Type Description
module:model/CreateStorageData
Source:

(static) CreateStorageDataAttributes

The CreateStorageDataAttributes model constructor.

Properties:
Type Description
module:model/CreateStorageDataAttributes
Source:

(static) CreateStorageDataRelationships

The CreateStorageDataRelationships model constructor.

Properties:
Type Description
module:model/CreateStorageDataRelationships
Source:

(static) CreateStorageDataRelationshipsTarget

The CreateStorageDataRelationshipsTarget model constructor.

Properties:
Type Description
module:model/CreateStorageDataRelationshipsTarget
Source:

(static) CreateVersion

The CreateVersion model constructor.

Properties:
Type Description
module:model/CreateVersion
Source:

(static) CreateVersionData

The CreateVersionData model constructor.

Properties:
Type Description
module:model/CreateVersionData
Source:

(static) CreateVersionDataRelationships

The CreateVersionDataRelationships model constructor.

Properties:
Type Description
module:model/CreateVersionDataRelationships
Source:

(static) CreateVersionDataRelationshipsItem

The CreateVersionDataRelationshipsItem model constructor.

Properties:
Type Description
module:model/CreateVersionDataRelationshipsItem
Source:

(static) CreateVersionDataRelationshipsItemData

The CreateVersionDataRelationshipsItemData model constructor.

Properties:
Type Description
module:model/CreateVersionDataRelationshipsItemData
Source:

(static) DerivativesApi

The DerivativesApi service constructor.

Properties:
Type Description
module:api/DerivativesApi
Source:

(static) Diagnostics

The Diagnostics model constructor.

Properties:
Type Description
module:model/Diagnostics
Source:

(static) Folder

The Folder model constructor.

Properties:
Type Description
module:model/Folder
Source:

(static) FolderAttributes

The FolderAttributes model constructor.

Properties:
Type Description
module:model/FolderAttributes
Source:

(static) FolderRelationships

The FolderRelationships model constructor.

Properties:
Type Description
module:model/FolderRelationships
Source:

(static) FoldersApi

The FoldersApi service constructor.

Properties:
Type Description
module:api/FoldersApi
Source:

(static) Forbidden

The Forbidden model constructor.

Properties:
Type Description
module:model/Forbidden
Source:

(static) Formats

The Formats model constructor.

Properties:
Type Description
module:model/Formats
Source:

(static) FormatsFormats

The FormatsFormats model constructor.

Properties:
Type Description
module:model/FormatsFormats
Source:

(static) Hub

The Hub model constructor.

Properties:
Type Description
module:model/Hub
Source:

(static) HubAttributes

The HubAttributes model constructor.

Properties:
Type Description
module:model/HubAttributes
Source:

(static) HubRelationships

The HubRelationships model constructor.

Properties:
Type Description
module:model/HubRelationships
Source:

(static) Hubs

The Hubs model constructor.

Properties:
Type Description
module:model/Hubs
Source:

(static) HubsApi

The HubsApi service constructor.

Properties:
Type Description
module:api/HubsApi
Source:

(static) IssuesApi

The IssuesApi service constructor.

Properties:
Type Description
module:api/IssuesApi
Source:

(static) Item

The Item model constructor.

Properties:
Type Description
module:model/Item
Source:

(static) ItemAttributes

The ItemAttributes model constructor.

Properties:
Type Description
module:model/ItemAttributes
Source:

(static) ItemCreated

The ItemCreated model constructor.

Properties:
Type Description
module:model/ItemCreated
Source:

(static) ItemRelationships

The ItemRelationships model constructor.

Properties:
Type Description
module:model/ItemRelationships
Source:

(static) ItemsApi

The ItemsApi service constructor.

Properties:
Type Description
module:api/ItemsApi
Source:

(static) Job

The Job model constructor.

Properties:
Type Description
module:model/Job
Source:

(static) JobAcceptedJobs

The JobAcceptedJobs model constructor.

Properties:
Type Description
module:model/JobAcceptedJobs
Source:

(static) JobDwgOutputPayload

The JobDwgOutputPayload model constructor.

Properties:
Type Description
module:model/JobDwgOutputPayload
Source:

(static) JobDwgOutputPayloadAdvanced

The JobDwgOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobDwgOutputPayloadAdvanced
Source:

(static) JobIfcOutputPayload

The JobIfcOutputPayload model constructor.

Properties:
Type Description
module:model/JobIfcOutputPayload
Source:

(static) JobIfcOutputPayloadAdvanced

The JobIfcOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobIfcOutputPayloadAdvanced
Source:

(static) JobIgesOutputPayload

The JobIgesOutputPayload model constructor.

Properties:
Type Description
module:model/JobIgesOutputPayload
Source:

(static) JobIgesOutputPayloadAdvanced

The JobIgesOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobIgesOutputPayloadAdvanced
Source:

(static) JobObjOutputPayload

The JobObjOutputPayload model constructor.

Properties:
Type Description
module:model/JobObjOutputPayload
Source:

(static) JobObjOutputPayloadAdvanced

The JobObjOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobObjOutputPayloadAdvanced
Source:

(static) JobPayload

The JobPayload model constructor.

Properties:
Type Description
module:model/JobPayload
Source:

(static) JobPayloadDestination

The JobPayloadDestination model constructor.

Properties:
Type Description
module:model/JobPayloadDestination
Source:

(static) JobPayloadInput

The JobPayloadInput model constructor.

Properties:
Type Description
module:model/JobPayloadInput
Source:

(static) JobPayloadItem

The JobPayloadItem model constructor.

Properties:
Type Description
module:model/JobPayloadItem
Source:

(static) JobPayloadMisc

The JobPayloadMisc model constructor.

Properties:
Type Description
module:model/JobPayloadMisc
Source:

(static) JobPayloadOutput

The JobPayloadOutput model constructor.

Properties:
Type Description
module:model/JobPayloadOutput
Source:

(static) JobStepOutputPayload

The JobStepOutputPayload model constructor.

Properties:
Type Description
module:model/JobStepOutputPayload
Source:

(static) JobStepOutputPayloadAdvanced

The JobStepOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobStepOutputPayloadAdvanced
Source:

(static) JobStlOutputPayload

The JobStlOutputPayload model constructor.

Properties:
Type Description
module:model/JobStlOutputPayload
Source:

(static) JobStlOutputPayloadAdvanced

The JobStlOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobStlOutputPayloadAdvanced
Source:

(static) JobSvf2OutputPayload

The JobSvf2OutputPayload model constructor.

Properties:
Type Description
module:model/JobSvf2OutputPayload
Source:

(static) JobSvf2OutputPayloadAdvanced

The JobSvf2OutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobSvf2OutputPayloadAdvanced
Source:

(static) JobSvfOutputPayload

The JobSvfOutputPayload model constructor.

Properties:
Type Description
module:model/JobSvfOutputPayload
Source:

(static) JobSvfOutputPayloadAdvanced

The JobSvfOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobSvfOutputPayloadAdvanced
Source:

(static) JobThumbnailOutputPayload

The JobThumbnailOutputPayload model constructor.

Properties:
Type Description
module:model/JobThumbnailOutputPayload
Source:

(static) JobThumbnailOutputPayloadAdvanced

The JobThumbnailOutputPayloadAdvanced model constructor.

Properties:
Type Description
module:model/JobThumbnailOutputPayloadAdvanced
Source:

(static) JsonApiAttributes

The JsonApiAttributes model constructor.

Properties:
Type Description
module:model/JsonApiAttributes
Source:

(static) JsonApiCollection

The JsonApiCollection model constructor.

Properties:
Type Description
module:model/JsonApiCollection
Source:

(static) JsonApiDocument

The JsonApiDocument model constructor.

Properties:
Type Description
module:model/JsonApiDocument
Source:

(static) JsonApiDocumentBase

The JsonApiDocumentBase model constructor.

Properties:
Type Description
module:model/JsonApiDocumentBase
Source:

(static) JsonApiError

The JsonApiError model constructor.

Properties:
Type Description
module:model/JsonApiError
Source:

(static) JsonApiErrorErrors

The JsonApiErrorErrors model constructor.

Properties:
Type Description
module:model/JsonApiErrorErrors
Source:

The JsonApiErrorLinks model constructor.

Properties:
Type Description
module:model/JsonApiErrorLinks
Source:

The JsonApiLink model constructor.

Properties:
Type Description
module:model/JsonApiLink
Source:

The JsonApiLinks model constructor.

Properties:
Type Description
module:model/JsonApiLinks
Source:

(static) JsonApiLinksPaging

The JsonApiLinksPaging model constructor.

Properties:
Type Description
module:model/JsonApiLinksPaging
Source:

(static) JsonApiLinksRelated

The JsonApiLinksRelated model constructor.

Properties:
Type Description
module:model/JsonApiLinksRelated
Source:

(static) JsonApiLinksSelf

The JsonApiLinksSelf model constructor.

Properties:
Type Description
module:model/JsonApiLinksSelf
Source:

(static) JsonApiMeta

The JsonApiMeta model constructor.

Properties:
Type Description
module:model/JsonApiMeta
Source:

The JsonApiMetaLink model constructor.

Properties:
Type Description
module:model/JsonApiMetaLink
Source:

(static) JsonApiRelationships

The JsonApiRelationships model constructor.

Properties:
Type Description
module:model/JsonApiRelationships
Source:

(static) JsonApiRelationshipsLinksExternalResource

The JsonApiRelationshipsLinksExternalResource model constructor.

Properties:
Type Description
module:model/JsonApiRelationshipsLinksExternalResource
Source:

(static) JsonApiRelationshipsLinksInternal

The JsonApiRelationshipsLinksInternal model constructor.

Properties:
Type Description
module:model/JsonApiRelationshipsLinksInternal
Source:

(static) JsonApiRelationshipsLinksInternalResource

The JsonApiRelationshipsLinksInternalResource model constructor.

Properties:
Type Description
module:model/JsonApiRelationshipsLinksInternalResource
Source:

(static) JsonApiRelationshipsLinksRefs

The JsonApiRelationshipsLinksRefs model constructor.

Properties:
Type Description
module:model/JsonApiRelationshipsLinksRefs
Source:

The JsonApiRelationshipsLinksRefsLinks model constructor.

Properties:
Type Description
module:model/JsonApiRelationshipsLinksRefsLinks
Source:

(static) JsonApiResource

The JsonApiResource model constructor.

Properties:
Type Description
module:model/JsonApiResource
Source:

(static) JsonApiTypeId

The JsonApiTypeId model constructor.

Properties:
Type Description
module:model/JsonApiTypeId
Source:

(static) JsonApiVersion

The JsonApiVersion model constructor.

Properties:
Type Description
module:model/JsonApiVersion
Source:

(static) JsonApiVersionJsonapi

The JsonApiVersionJsonapi model constructor.

Properties:
Type Description
module:model/JsonApiVersionJsonapi
Source:

(static) Manifest

The Manifest model constructor.

Properties:
Type Description
module:model/Manifest
Source:

(static) ManifestChildren

The ManifestChildren model constructor.

Properties:
Type Description
module:model/ManifestChildren
Source:

(static) ManifestDerivative

The ManifestDerivative model constructor.

Properties:
Type Description
module:model/ManifestDerivative
Source:

(static) Message

The Message model constructor.

Properties:
Type Description
module:model/Message
Source:

(static) Messages

The Messages model constructor.

Properties:
Type Description
module:model/Messages
Source:

(static) Metadata

The Metadata model constructor.

Properties:
Type Description
module:model/Metadata
Source:

(static) MetadataCollection

The MetadataCollection model constructor.

Properties:
Type Description
module:model/MetadataCollection
Source:

(static) MetadataData

The MetadataData model constructor.

Properties:
Type Description
module:model/MetadataData
Source:

(static) MetadataMetadata

The MetadataMetadata model constructor.

Properties:
Type Description
module:model/MetadataMetadata
Source:

(static) MetadataObject

The MetadataObject model constructor.

Properties:
Type Description
module:model/MetadataObject
Source:

(static) NotFound

The NotFound model constructor.

Properties:
Type Description
module:model/NotFound
Source:

(static) ObjectDetails

The ObjectDetails model constructor.

Properties:
Type Description
module:model/ObjectDetails
Source:

(static) ObjectFullDetails

The ObjectFullDetails model constructor.

Properties:
Type Description
module:model/ObjectFullDetails
Source:

(static) ObjectFullDetailsDeltas

The ObjectFullDetailsDeltas model constructor.

Properties:
Type Description
module:model/ObjectFullDetailsDeltas
Source:

(static) ObjectS3Download

The ObjectS3Download model constructor.

Properties:
Type Description
module:model/ObjectS3Download
Source:

(static) ObjectS3Upload

The ObjectS3Upload model constructor.

Properties:
Type Description
module:model/ObjectS3Upload
Source:

(static) ObjectsApi

The ObjectsApi service constructor.

Properties:
Type Description
module:api/ObjectsApi
Source:

(static) Permission

The Permission model constructor.

Properties:
Type Description
module:model/Permission
Source:

(static) PostBucketsPayload

The PostBucketsPayload model constructor.

Properties:
Type Description
module:model/PostBucketsPayload
Source:

(static) PostBucketsPayloadAllow

The PostBucketsPayloadAllow model constructor.

Properties:
Type Description
module:model/PostBucketsPayloadAllow
Source:

(static) PostBucketsSigned

The PostBucketsSigned model constructor.

Properties:
Type Description
module:model/PostBucketsSigned
Source:

(static) PostObjectSigned

The PostObjectSigned model constructor.

Properties:
Type Description
module:model/PostObjectSigned
Source:

(static) Project

The Project model constructor.

Properties:
Type Description
module:model/Project
Source:

(static) ProjectAttributes

The ProjectAttributes model constructor.

Properties:
Type Description
module:model/ProjectAttributes
Source:

(static) ProjectRelationships

The ProjectRelationships model constructor.

Properties:
Type Description
module:model/ProjectRelationships
Source:

(static) Projects

The Projects model constructor.

Properties:
Type Description
module:model/Projects
Source:

(static) ProjectsApi

The ProjectsApi service constructor.

Properties:
Type Description
module:api/ProjectsApi
Source:

(static) Reason

The Reason model constructor.

Properties:
Type Description
module:model/Reason
Source:

(static) Refs

The Refs model constructor.

Properties:
Type Description
module:model/Refs
Source:

(static) RelRef

The RelRef model constructor.

Properties:
Type Description
module:model/RelRef
Source:

(static) RelRefMeta

The RelRefMeta model constructor.

Properties:
Type Description
module:model/RelRefMeta
Source:

(static) ResourceId

The ResourceId model constructor.

Properties:
Type Description
module:model/ResourceId
Source:

(static) Result

The Result model constructor.

Properties:
Type Description
module:model/Result
Source:

(static) Storage

The Storage model constructor.

Properties:
Type Description
module:model/Storage
Source:

(static) StorageCreated

The StorageCreated model constructor.

Properties:
Type Description
module:model/StorageCreated
Source:

(static) StorageRelationships

The StorageRelationships model constructor.

Properties:
Type Description
module:model/StorageRelationships
Source:

(static) StorageRelationshipsTarget

The StorageRelationshipsTarget model constructor.

Properties:
Type Description
module:model/StorageRelationshipsTarget
Source:

(static) StorageRelationshipsTargetData

The StorageRelationshipsTargetData model constructor.

Properties:
Type Description
module:model/StorageRelationshipsTargetData
Source:

(static) TokensApi

The TokensApi service constructor.

Properties:
Type Description
module:api/TokensApi
Source:

(static) TopFolders

The TopFolders model constructor.

Properties:
Type Description
module:model/TopFolders
Source:

(static) UserProfile

The UserProfile model constructor.

Properties:
Type Description
module:model/UserProfile
Source:

(static) UserProfileApi

The UserProfileApi service constructor.

Properties:
Type Description
module:api/UserProfileApi
Source:

(static) UserProfileProfileImages

The UserProfileProfileImages model constructor.

Properties:
Type Description
module:model/UserProfileProfileImages
Source:

(static) Version

The Version model constructor.

Properties:
Type Description
module:model/Version
Source:

(static) VersionAttributes

The VersionAttributes model constructor.

Properties:
Type Description
module:model/VersionAttributes
Source:

(static) VersionCreated

The VersionCreated model constructor.

Properties:
Type Description
module:model/VersionCreated
Source:

(static) VersionRelationships

The VersionRelationships model constructor.

Properties:
Type Description
module:model/VersionRelationships
Source:

(static) Versions

The Versions model constructor.

Properties:
Type Description
module:model/Versions
Source:

(static) VersionsApi

The VersionsApi service constructor.

Properties:
Type Description
module:api/VersionsApi
Source:

(static) WebhooksApi

The WebhooksApi service constructor.

Properties:
Type Description
module:api/WebhooksApi
Source:

Methods

(static) setDebug(isDebug)

Optionally enable debugging

Parameters:
Name Type Description
isDebug
Source: