Home > @tridion-sites/open-api-client
This package allows extensions developers to easily interact with Tridion Sites API. It provides a convenient interface for making HTTP requests and working with the API.
Due to reliance on various functionality provided at runtime by Tridion Sites, this package is not suitable for standalone usage and can only be utilized as a part of an extension.
| Enumeration | Description |
|---|---|
| ActivityConstraints | <p>Defines the constraints of an Activity Instance.</p><p>Members: * None - Does not have any constraints.</p><p>* DenyBundleMetadataEditing - Denies editing Metadata of a Bundle in workflow.</p><p>* DenySubjectEditing - Denies editing Subject in workflow.</p><p>* DenyAddRemoveWorkItem - Denies adding/removing work items to/from the Activity.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ActivityState | <p>Defines a state of an Activity.</p><p>Members: * Assigned - The Activity is assigned to the User or Group.</p><p>* Started - The Activity is started by a User.</p><p>* Failed - The Activity is failed.</p><p>* Finished - The Activity is finished.</p><p>* Suspended - The Activity is suspended.</p><p>* WaitingForWorkflowAgent - The Activity is waiting for execution by Workflow Agent.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ActivityType | <p>Defines a type of an Activity.</p><p>Members: * Normal - Normal activity.</p><p>* Decision - Decision activity.</p> |
| BatchOperationState | <p>The state of the batch operation.</p><p>Members: * NotStarted - Batch operation wasn’t started yet.</p><p>* Success - Batch operation was successfully finished.</p><p>* Warning - Batch operation was finished with warning.</p><p>* Error - Batch operation wasn’t finished due to an error.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ComponentType | <p>Defines the subtype of a Component.</p><p>Members: * Normal - A normal Component containing XML content. * Multimedia - A Multimedia Component containing binary content. * Widget - A widget Component - a dedicated variant of the normal Component. * UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ConditionOperator | <p>Defines an operator used for comparison.</p><p>Members: * Equals - Compares if a numerical operand is equal to the given condition value.</p><p>* GreaterThan - Compares if a numerical operand is greater than the given condition value.</p><p>* LessThan - Compares if a numerical operand is less than the given condition value.</p><p>* NotEqual - Compares if a numerical operand is not equal to the given condition value.</p><p>* StringEquals - Compares if a string operand is equal to the given condition value.</p><p>* Contains - Compares if a string operand contains the given condition value.</p><p>* StartsWith - Compares if a string operand starts with the given condition value.</p><p>* EndsWith - Compares if a string operand ends with the given condition value.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| DeleteTaxonomyNodeMode | <p>Specifies what will happen to the child nodes of a Taxonomy node after that node’s deletion.</p><p>Members: * DeleteBranch - Specifies that the entire branch of descendant nodes will be deleted, excluding nodes in child Publications.</p><p>* DeleteBranchIncludeChildPublications - Specifies that the entire branch of descendants will be deleted, including nodes in child Publications.</p><p>* RemoveParentFromChildren - Specifies that the deleted node will be removed from the children’s parents. Children will become root if they have no other parents. If the children have other parents, those parents are preserved.</p><p>* AssignChildrenToGrandparents - Specifies that the parents of the deleted node adopt the deleted node’s children. If the children have other parents, those parents are preserved.</p> |
| DependencyDirection | <p>Specifies the direction of dependencies in a dependency graph.</p><p>Members: * Uses - The dependencies represent items which the given items refers to</p><p>* UsedBy - The dependencies represent items which are referring to the given item</p> |
| DeployerAction | <p>Represents the action the deployer needs to take.</p><p>Members: * Commit - The deployer should commit the transport package.</p><p>* Wait - The deployer should wait to commit the transport package.</p><p>* Abort - The deployer should abort the transport package.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| DirectorySearchType | <p>Search types for the Directory Group Mapping.</p><p>Members: * Subtree - Search in the given subtree.</p><p>* Group - Search in the given group.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ErrorSeverity | <p>Indicates the severity of an error sending or retrieving a Translation Job.</p><p>Members: * Info - Information.</p><p>* Warning - Errors that can impact usability but does not impact sending or retrieving Items (for example old jobs not being deleted)</p><p>* Error - Errors stopping Items from being send to translation or retrieved from translation.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ErrorType | <p>Enum of load error types.</p><p>Members: * None - No error.</p><p>* Error - General error.</p><p>* SecurityError - User has no permissions to read an item.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ItemType | |
| LinkTargetStatus | <p>Defines Link’s target status</p><p>Members: * NotFound - Target item not found</p><p>* NotAvailable - Target provider is not available</p><p>* NoPermission - Target item is not accessible</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ListDetails | <p>Specifies the level of details of list entries.</p><p>Members: * IdAndTitleOnly - Include only the Id and Title properties.</p><p>* WithApplicableActions - Include several properties, including .</p><p>* Contentless - Include all but “expensive” properties (exclude custom content/metadata, for example).</p> |
| ListType | <p>Specifies the type of list used to present allowed field values.</p><p>Members: * None - Don’t present a list of allowed values. * Select - Present a select list (or drop-down list if Height=1) * Radio - Present radio buttons. * Checkbox - Present check boxes. * Tree - Present a tree (Taxonomy). * UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| LoadInfoState | <p>Enum of load states.</p><p>Members: * FullyLoaded - An item is fully loaded.</p><p>* PartiallyLoaded - An item is partially loaded.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| LockType | <p>Defines the state (lock) of an item.</p><p>Members: * None - The item is not locked. * CheckedOut - The item is checked-out. This can mean either a temporary (edit) lock, a permanent lock (explicit check-out performed by user) or a workflow lock. * Permanent - The item is permanently locked, that is using an explicit lock (check-out) action. Can be applied to versioned items (permanent check-out) and to organizational items. * NewItem - The item is a new item, that is it has been created, but not checked-in for the first time yet. * InWorkflow - The item is in a workflow. * Reserved - The item is reserved by the system. This means it is checked-out/locked, but nobody owns the lock.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ModelType | <p>Specifies the Model types that are supported by the Content Manager.</p><p>Members: * Bundle - Bundle.</p><p>* SearchFolder - Search folder.</p><p>* Schema - Schema.</p><p>* Page - Page.</p><p>* PageTemplate - Page template.</p><p>* Component - Component.</p><p>* ComponentTemplate - Component template.</p><p>* Folder - Folder.</p><p>* Keyword - Keyword.</p><p>* StructureGroup - Structure group.</p><p>* TemplateBuildingBlock - Template building block.</p><p>* Publication - Publication.</p><p>* Category - Category.</p><p>* Group - Group.</p><p>* ProcessDefinition - Process definition.</p><p>* BusinessProcessType - Business process type.</p><p>* MultimediaType - Multimedia type.</p><p>* TargetType - Target type.</p><p>* User - User.</p><p>* TargetGroup - Target group.</p><p>* ApprovalStatus - Approval status.</p> |
| NumericalConditionOperator | <p>Defines the operator used for comparison of numerical operands.</p><p>Members: * Equals - Compares if a numerical operand is equal to the given condition value.</p><p>* GreaterThan - Compares if a numerical operand is greater than the given condition value.</p><p>* LessThan - Compares if a numerical operand is less than the given condition value.</p><p>* NotEqual - Compares if a numerical operand is not equal to the given condition value.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| OperationMode | <p>Specifies the type of behavior when validation errors occur.</p><p>Members: * FailOnError - Fails the operation in case of any validation error found (warnings are returned in the operation result, but do not break operation).</p><p>* FailOnWarning - Fails the operation in case of any validation error or warning found.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| Permissions_2 | <p>Specifies the Permissions used for security checks.</p><p>Members: * None - No permission to access the items.</p><p>* Read - Grants read access to items.</p><p>* Write - Grants write access to items.</p><p>* Delete - Grants delete access to items.</p><p>* Localize - Grants localize and unlocalize access to items.</p><p>* All - Grants all permissions to access the items.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ProcessFinishReason | <p>Defines the reason a Process is going to be finished or has finished already.</p><p>Members: * CompletedNormally - Identifies if the process has finished normally.</p><p>* ForceFinished - Identifies if the process was forcefully finished.</p><p>* Terminated - Identifies if the process was terminated.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| PublishAction | <p>Distinguishes publishing and un-publishing actions.</p><p>Members: * Publish - Publishing</p><p>* UnPublish - Un-publishing</p> |
| PublishPriority | <p>Identifies the priority of the publish action.</p><p>Members: * Low - Low priority.</p><p>* Normal - Normal priority.</p><p>* High - High priority.</p> |
| PublishTransactionState | <p>Represents the states a Publish Transaction can have.</p><p>Members: * ScheduledForPublish - The PublishTransaction is scheduled to start at the specified date time.</p><p>* WaitingForPublish - The PublishTransaction is waiting to be processed.</p><p>* InProgress - The PublishTransaction is currently in progress.</p><p>* ScheduledForDeployment - The PublishTransaction is scheduled to be deployed at the specified date time.</p><p>* WaitingForDeployment - The PublishTransaction is waiting to be deployed at the specified date time.</p><p>* Failed - The PublishTransaction failed.</p><p>* Success - The PublishTransaction succeeded.</p><p>* Warning - The PublishTransaction succeeded but contains warnings.</p><p>* Resolving - The PublishTransaction is currently being resolved.</p><p>* Rendering - The PublishTransaction is currently being rendered.</p><p>* Throttled - The PublishTransaction is currently being throttled by the TransportService.</p><p>* ReadyForTransport - The PublishTransaction is currently ready for transport.</p><p>* Transporting - The PublishTransaction is currently being transported to the destinations.</p><p>* Deploying - The PublishTransaction is currently being deployed.</p><p>* PreparingDeployment - The PublishTransaction is currently being prepared for deployment.</p><p>* PreCommittingDeployment - The PublishTransaction is in the pre-committing deployment phase.</p><p>* CommittingDeployment - The PublishTransaction is being committed for the deployment.</p><p>* WaitingForCdEnvironment - The PublishTransaction is waiting for Content Delivery Environment to be online.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| ResolveOptions | <p>Defines which Items will be included in the Translation Job for an .</p><p>Members: * TranslateContainerItems - Translate container items (Folders, Pages, Structure Groups, etc.)</p><p>* TranslateSubItems - Translate the items inside of containers (Components, Keywords, etc.)</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| RetrieveReason | <p>Used in to indicate why the item was retrieved.</p><p>Members: * Unknown - The reason is not known. Most likely the item was retrieved by a previous version of Translation Manager that could only retrieve items when they were Completed.</p><p>* Completed - The item was completed in the Translation Management system. Translation Manager consider the Item completed and will complete the Translation Job once all items are in this stage.</p><p>* Review - The item was retrieved to allow review in Tridion Sites. The item remains in control of the translation management system’s workflow and Translation Manager will attempt to retrieve the Item again.</p><p>* Preview - The item was retrieved to allow preview in Tridion Sites. The item remains in control of the translation management system’s workflow and Translation Manager will attempt to retrieve the Item again.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| Rights | <p>Specifies the Rights used for security checks.</p><p>Members: * None - No rights.</p><p>* PublicationAccess - Grants access to a publication.</p><p>* PublicationManagement - Grants publication properties update.</p><p>* FolderManagement - Grants create, update, delete rights on Folder.</p><p>* StructureGroupManagement - Grants create, update, delete rights on StructureGroup.</p><p>* SchemaManagement - Grants create, update, delete rights on Schema.</p><p>* ComponentManagement - Grants create, update, delete rights on Components.</p><p>* ComponentTemplateManagement - Grants create, update, delete rights on ComponentTemplates.</p><p>* PageManagement - Grants create, update, delete rights on Pages.</p><p>* PageTemplateManagement - Grants create, update, delete rights on PageTemplates.</p><p>* ProfileManagement - Grants create, update, delete rights on TargetGroups.</p><p>* PublishManagement - Grants rights to publish.</p><p>* PermissionManagement - Grants rights to change rights on Repository and permissions on Organizational Items.</p><p>* WorkflowManagement - Grants create, update, delete rights to manage Workflow. To grant workflow management rights to a trustee, the WorkflowManager privilege must be used.</p><p>* CategoryManagement - Grants create, update, delete rights on Categories.</p><p>* TemplateBuildingBlockManagement - Grants create, update, delete rights on TemplateBuildingBlocks.</p><p>* VirtualFolderManagement - Grants create, update, delete rights on VirtualFolders.</p><p>* BundleManagement - Grants create, update, delete rights on Bundles.</p><p>* BusinessProcessTypeManagement - Grants create, update, delete rights on Business Process Type.</p><p>* PublicationAdministration - Grants repository-local administration rights.</p><p>* LockManagement - Grants the user rights to unlock items locked by other users.</p><p>* All - All rights.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| RLOItemType | <p>Specifies the subset of the Item types which are the Repository Local Object model.</p><p>Members: * Folder - Folder.</p><p>* StructureGroup - Structure group.</p><p>* Schema - Schema.</p><p>* Component - Component.</p><p>* ComponentTemplate - Component template.</p><p>* Page - Page.</p><p>* PageTemplate - Page template.</p><p>* TargetGroup - Target group.</p><p>* Category - Category.</p><p>* Keyword - Keyword.</p><p>* TemplateBuildingBlock - Template building block.</p><p>* BusinessProcessType - Business Process Type.</p><p>* VirtualFolder - Virtual folder (Search Folder or Bundle).</p><p>* ProcessDefinition - Workflow Process Definition.</p><p>* All - Represents all Repository Local Object types.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| SchemaPurpose | <p>Defines a purpose of a Schema, that is in which items the Schema can be used.</p><p>Members: * Component - Schema defines the content and metadata of Components with XML content. * Multimedia - Schema defines the content and metadata of Multimedia Components. * Embedded - Schema is included into other Schemas. * Metadata - Schema defines the metadata of items (except for Components). * Protocol - Schema defines the protocol fields of a Publication Target. * VirtualFolderType - Schema defines the configuration data of a Virtual Folder. * TemplateParameters - Schema defines the parameters of a Template. * Bundle - Schema defines the metadata and process definition of a Bundle. * Region - Schema defines the Region definition and metadata. * UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| SearchBlueprintStatus | <p>Specifies the Blueprint status to search for.</p><p>Members: * Unspecified - Don’t search for a specific Blueprint status</p><p>* Local - Search for local items</p><p>* Localized - Search for localized items (a.k.a. local copies)</p><p>* Shared - Search for shared items</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| StringSearchMode | Members: * Contains - * StartsWith - * EndsWith - * ExactMatch - |
| StructureResolveOption | <p>Represents the option to include the resolved items and/or structure.</p><p>Members: * OnlyItems - Only item(s) will be resolved. This is the default value.</p><p>* OnlyStructure - Only Structure Group(s) will be resolved.</p><p>* ItemsAndStructure - Structure Group(s) along with item(s) will be resolved.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| SynchronizeFlags | <p>Specifies how the Repository Local Object should/can be synchronized with its Schema.</p><p>Members: * Basic - Use only basic option, which includes re-ordering fields.</p><p>* FixNamespace - Fix the namespace of content and metadata element as per the schema.</p><p>* RemoveUnknownFields - Remove any fields which do not exist in the schema.</p><p>* RemoveAdditionalValues - Remove fields which occur more than allowed in MaxOccurs.</p><p>* ApplyDefaultValuesForMissingMandatoryFields - Apply default values to mandatory fields which are missing.</p><p>* ApplyDefaultValuesForMissingNonMandatoryFields - Apply default values to non-mandatory fields which are missing.</p><p>* ApplyFilterXsltToXhtmlFields - Apply Xslt transformation to Xhtml fields.</p><p>* ConvertFieldType - Convert field types as specified in schema.</p><p>* UpdateRegions - Update nested regions structure of the page.</p><p>* SyncNonLocalizableFields - Ensure that non-localizable fields in a Local Copy are in sync with the Primary BluePrint Parent Item.</p><p>* SyncNonLocalizableRegions - Ensure that non-localizable Page Regions in a Local Copy are in sync with the Primary BluePrint Parent Item.</p><p>* All - Apply all possible transformations.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| TranslationJobDisplayState | <p>Gets the state that should be displayed in the UI for the . This is slightly more detailed than the .</p><p>Members: * Error - The is in an error state not related to retrieval or sending the . The errors are available in .</p><p>* Canceled - The was canceled in the translation management system before all items where retrieved.</p><p>* Completed - The translation of the has been completed.</p><p>* Definition - It is still possible to edit the before it is send for translation.</p><p>* AwaitingAuthorization - One or more s is ready for authorization.</p><p>* AwaitingAuthorizationAndError - One or more s is ready for authorization and one or more errors is available in .</p><p>* ErrorRetrieving - The is in an error state related to retrieving translations. The errors are available in .</p><p>* InTranslation - The is currently in translation. Some - but not all - items might have been canceled or completed.</p><p>* ErrorSending - The is in an error state related to sending the Items for translation. The errors are available in .</p><p>* SubmittingToTranslation - The is currently being send to the translation management system by the Translation Manager windows service.</p><p>* ReadyForTranslation - The is no longer in state and is ready to be send for translation by the Translation Manager windows service.</p><p>* Deleting - The is being deleted by the Translation Manager windows service.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| TranslationJobPriority | <p>Specifies the priority of the translation job. Higher priority jobs will be send to the TMS server first.</p><p>Members: * Low - Low priority</p><p>* Normal - Normal priority</p><p>* High - High priority</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| TranslationJobState | <p>State of a translation job.</p><p>Members: * Canceled - The job has been canceled.</p><p>* Definition - The job is in definition state - it can still be edited.</p><p>* ReadyForTranslation - The job has been defined, and is waiting for the Translation Manager Service to retrieve it.</p><p>* SubmittingToTranslation - The job is being transferred to the translation management system.</p><p>* InTranslation - The job is under control of the translation management system.</p><p>* Completed - The job has been completed.</p><p>* ReadyForDeletion - The job can be deleted and is waiting for the service to pick up the task.</p><p>* Deleting - The job is currently being deleted.</p><p>* None - Unspecified state (used to get jobs for all states).</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| TranslationJobType | <p>The Translation job type (push or pull)</p><p>Members: * None - Unspecified job type (used to get jobs for all types).</p><p>* PushJob - Job that pushes translation from one translation source to one or more targets.</p><p>* PullJob - Job that pulls the translation from one or more source languages to the context target.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| TranslationStatus | <p>Represents translation status of an Item.</p><p>Members: * NotTranslated - Item is not translated.</p><p>* InProgress - Translation in progress.</p><p>* UpToDate - Items contains latest translation of source.</p><p>* NewSourceVersionExists - New version of source available.</p><p>* NewTargetVersionExists - Previous version of target item contains translation but target item was changed after.</p><p>* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.</p> |
| WhereUsedCommentToken | <p>Kind of relationship between this item and used item</p><p>Members: * ParentItem - Specifies that the list item represents the (direct) BluePrint Parent Item of the given item. * LocalCopy - Specifies that the list item represents a Local Copy of the given item. * OnlyOldVersions - Specifies that only old versions of the list item are referring to the given item. * OnlyCheckedOutVersion - if only the checked-out version of an item refers to the given item. * UnknownByClient - Special reserved value used to notify a legacy client about receiving an enumeration value added in a newer version of the service. Explicitly setting this value by a client is not allowed (it can only be set internally by the service), but client code should check it and be able to handle such cases.</p> |
| Variable | Description |
|---|---|
| OpenAPI |
| Type Alias | Description |
|---|---|
| AbstractBatchPublishRequest | Represents the abstract request for the publish/un-publish batch operations. |
| AccessControlEntry | Represents an entry in an Access Control List, which is used to restrict access to containers. An Access Control Entry specifies which Permissions and/or Rights a given “Trustee” has. Permissions and Rights can either be Allowed, Denied or Implicit Denied. |
| AccessControlList | Represents an Access Control List which is used to restrict access to a container. |
| AccessToken | Represents read-only access token data. |
| Activity | Abstract base class for the data of Activities. |
| ActivityDecisionFinishInfo | Represents the data required for finishing an Decision Activity. |
| ActivityDefinition | Abstract base class for the data of the Activity Definitions. Part of the Process Definition. |
| ActivityFinishInfo | Represents the data required for finishing an Activity. |
| ActivityFinishRequest | Represents the data required for finishing an Activity. |
| ActivityHistory | Representing data of the Activity History. This is the part of “ProcessHistory”. |
| ActivityInstance | Represents the data of an Activity Instance: a current Activity which is part of a Process Instance (V2). |
| ActivityInstanceBase | Represents the data of an Activity Instance: a current Activity which is part of a Process Instance. |
| AddedItem | Represents an Item added to a {Tridion.TranslationManager.OpenApi.V3.Dto.TranslationJob}.The item added to a Translation Job is not necessarily the item that is send for translation. For example, if a Page is added without specifying the TranslateParentItems flag in the , the Components on the Page are included in the Translation Job but the Page itself will not.To change the items included in the Translation Job directly, use a Tridion Sites event subscription with the event arguments. |
| ApiStatus | Represents the status of the CoreService REST API. |
| ApprovalStatus | Represents a data of the Approval Status. |
| BasedOnSchema | Represents a data object of BasedOnSchema. |
| BasicVersionInfo | Basic version information about any Identifiable Object. |
| Batch | Represents the data of a Batch. Defines batch operations and additional info related to batch invocation. |
| BatchAutoClassifyRequest | Represents the request for the auto-classify batch operation. |
| BatchCheckInRequest | Represents the request for the check-in batch operation. |
| BatchCheckOutRequest | Represents the request for the check-out batch operation. |
| BatchClassifyOrUnClassifyRequest | Represents the request for the classify or un-classify batch operation. |
| BatchCopyOrMoveRequest | Represents the request for the copy or move batch operation. |
| BatchCopyRequest | Represents the request for the copy batch operation. |
| BatchDeleteTaxonomyNodeRequest | Represents the request for the delete taxonomy node batch operation. |
| BatchFinishActivityRequest | Represents the request for the finish activity batch operations. |
| BatchForceFinishRequest | Represents the request for the force finish batch operations. |
| BatchOperation | Provides information about batch operation on the list of subjects. |
| BatchOperationCreationResult | The result of the creation of the batch operation. |
| BatchOperationRequest | Represents the request for the batch operation. |
| BatchOperationRequestBase | Represents the abstract request for the batch operation. |
| BatchOperationStatus | Contains information about performing batch operation on concrete subject. |
| BatchPromoteDemoteRequest | Represents the request for the promote or demote batch operations. |
| BatchPublishRequest | Represents the request for the publish batch operation. |
| BatchReAssignActivityRequest | Represents the request for the re-assign activity batch operation. |
| BatchReClassifyRequest | Represents the request for the re-classify batch operation. |
| BatchSuspendActivityRequest | Represents the request for the suspend activity batch operation. |
| BatchSwitchUserEnabledStateRequest | Represents the request for the batch operation that changes the enabled state of users. |
| BatchUndoCheckOutRequest | Represents the request for the undo check-out batch operation. |
| BatchUnPublishRequest | Represents the request for the un-publish batch operation. |
| BinaryContent | Represents the binary content of a Multimedia Component or a Template. |
| BinaryUploadResponse | Represents information about uploaded file. |
| BlueprintHierarchyResponse | Response model for Blueprint Hierarchy request |
| BlueprintInfo | BluePrint info for Repository-Local Objects. |
| BlueprintNode | Represent blueprint node when retrieving the hierarchy. |
| Bundle | Represents a Bundle which is used to group Repository Local Objects for Release Management purposes. |
| BusinessProcessType | <p>Represents a Business Process Type: defines a type of (publishing) Business Process, including a set of publishing Target Types and workflows. It is a root organizational item. Title must be unique across its blueprint hierarchy; like all other root organizational items.</p><p>Metadata Schema, Bundle Schemas and Target Types of a Business Process Type are not localizable. AccessControlListData and IsPermissionsInheritanceRoot cannot be set for a Business Process Type. GetList and GetListXml return the associated “BundleSchemas”.</p><p>When reading a Business Process Type the associated Target Types are returned without its Access Control List, if that information is needed, then, the Business Process Type should be loaded with LoadFlags.Expanded.</p> |
| Capabilities | Represents information about available capabilities and features |
| Category | Represents the data of a Category of Keywords. |
| CheckInRequest | Removes permanent lock and creates a new version of the item. |
| CheckOutRequest | Checks out versioned item. |
| ClaimMapping | Abstract base class representing the data of a mapping between a Claim and a TCM Group. |
| ClassificationDetail | Classsification details for a particular field. |
| ClassificationInfo | Contains classification information for an Item. |
| Component | Represents the data of a Component: a generic holder of content and metadata. |
| ComponentLinkFieldDefinition | Represents a Component link field definition (in a Schema). |
| ComponentPresentation | Represents a Component Presentation: essentially a combination of a Component and a Component Template. |
| ComponentPresentationConstraint | Base class for Component Presentation Constraints (specified in a Region Schema). |
| ComponentTemplate | Represents a Component Template: a template used to render a Component into a Component Presentation. |
| Condition | Abstract base class for Conditions used in a Target Group definition. |
| CustomerCharacteristicCondition | Represents a condition on a Customer Characteristic (a named value in the user profile). |
| DateFieldDefinition | Represents a date field definition (in a Schema). |
| DateListDefinition | Provides information about whether/how to present a list of allowed date field values. |
| DecisionActivityFinishRequest | Represents the data required for finishing a decision Activity. |
| DependencyGraphNode | Represents a node in a dependency graph. |
| DirectoryGroupMapping | Represents the data of a mapping between a Directory Service Group or Subtree and a TCM Group. |
| DynamicVersionInfo | Represents information about the dynamic version of a Versioned Item. |
| EmbeddedRegion | Represents the data object of an Embedded Region. |
| EmbeddedSchemaFieldDefinition | Represents an embedded schema field definition (in a Schema). |
| ErrorDetails | Provides details for errors occurring while sending or retrieving {Tridion.TranslationManager.OpenApi.V3.Dto.TranslationJob}s. |
| ExceptionDetails | Provides details about the |
| ExpandableLink | Represents a link to an Identifiable Object which may contain the linked data. |
| ExtensionPropertyDictionary | Represents a collection of Extension Properties. |
| ExternalCategory | Represents an External Category (mapped to an external Taxonomy Management System). |
| ExternalComponent | Represents a External Component: an item provided from external system. |
| ExternalContainer | Represents a External Container: a container provided from external system. |
| ExternalKeyword | Represents an External Keyword (mapped to an external Taxonomy Management System). |
| ExternalLinkFieldDefinition | Represents an external link field definition (in a Schema). |
| ExternalVersionInfo | Version info for External Components. |
| FavoriteLink | Represents the link to a favorite item. |
| FieldsDefinitionDictionary | Represents the set of Item Field Definitions grouped by the field definition name. |
| FieldsValueDictionary | Represents the set of field values grouped by the field name. |
| FinishActivityResult | Container of the next ActivityInstance in the workflow |
| Folder | Represents the data of a Folder: an item used to organize the items in a Repository. |
| FormattingFeatures | Represents the formatting options. |
| FrontendAddon | Represents an Experience Space addon |
| FrontendExtension | Represents an Experience Space extension |
| FullVersionInfo | Full version info for Versioned Items. |
| Group | Represents a data of Group of Users. |
| GroupMembership | Contains the scope of a Group. |
| HateoasLink | Represents the hateoas link. |
| IdentifiableObject | Abstract base class for all objects that can be identified using a “TCM URI”>. |
| IdentifiableObjectDictionary | Represents the set of Identifiable Objects grouped by the Identifiable Object Id. |
| IdentityProviderGroupMapping | Represents the data of a mapping from an Identity Provider Group to a TCM Group. |
| ItemFieldDefinition | Abstract base class for Item Field Definitions (specified in a Schema) |
| ItemPublishableFieldDefinition | Abstract base class for Item Field Definitions for the field types that can be published. |
| Keyword | Represents the data of a Keyword used to classify items. |
| KeywordFieldDefinition | Represents a Keyword field definition (in a Schema). |
| KeywordSuggestion | Represents a keyword suggestion for a given source. |
| KeywordSuggestions | List of suggested keywords, grouped by the URI of the category that they belong to. |
| LimitedVersionInfo | Limited version info for Repository-Local Objects. |
| Link | Base class for links to Identifiable Objects. |
| LinkDictionary | Represents the set of links grouped by the link definition. |
| LinkWithIsEditable | Represents a link to an Identifiable Object with the option to set if it is allowed to edit the linked Object. |
| ListDefinition | Provides information about how a list of values should be represented to the user. |
| ListInfo | Abstract base class for additional information for list entries (when details=WithApplicableActions). |
| LoadInfo | Represents the information about the error that was thrown while loading an item. |
| LocationInfo | Location/context info for Repository-Local Objects. |
| LockInfo | Lock information about Repository Local Object. |
| MultiLineTextFieldDefinition | Represents a multi-line text field definition (in a Schema). |
| MultimediaLinkFieldDefinition | Represents a Multimedia link field definition (in a Schema). |
| MultimediaType | Represents a Multimedia Type: a type of binary content |
| NestedRegion | Represents the nested region definition. |
| NumberFieldDefinition | Represents a number field definition (in a Schema). |
| NumberListDefinition | Provides information about whether/how to present a list of allowed number field values. |
| OccurrenceConstraint | Represents an occurrence constraint for Component Presentation(s) in a Region Schema. |
| OpenAPIConfig | |
| OperationInstruction | Optional instructions that control how an operation will be executed. |
| OperationResult | <p>Contains information about performed operation. An operation can be failed due to warnings, if this was requested by the caller.</p><p>The “Result” will be null if requested operation return type is void.</p> |
| OrganizationalItem | Abstract base class for the data of “organizational items”: items used to organize the items in a Repository. |
| Page | Represents the data of a Page: an artifact in the Publication’s target structure. |
| PageOfItems | Represents a page of items (Repository Local Objects). |
| PageTemplate | Represents a Page Template: a template used to render a Page. |
| ParametersDictionary | Represents multiple sets of the parameters grouped by name. |
| Process | Abstract base class for the data of Processes. |
| ProcessDefinition | Abstract base class for the data of Process Definitions. |
| ProcessDefinitionAssociation | Representing data object of the Process Definition Association |
| ProcessedItem | Represents the Processed Item data, which contains rendering information for the Resolved Item. |
| ProcessHistory | Representing data of a Process History. |
| ProcessInstance | Represents the data of a Process Instance: a current Process. |
| PromoteDemoteRequest | Represents the data required for promoting and demoting an item. |
| Publication | Represents the data of a Publication: a “Repository” used for publishing. |
| PublicationType | Represents a PublicationType |
| PublishContext | Represents the data of a Publish Context. |
| PublishInfo | Represents publishing information for Repository local objects. |
| PublishingTarget | Abstract base class for classes that represent a target for publishing: Target Type and Publication Target. |
| PublishInstruction | Represents the instructions needed for publishing an item. |
| PublishInstructionBase | Represents the instructions needed for (un)publishing an item. |
| PublishLocationInfo | Represents a publishing location information for the objects that reside in Structure Groups. |
| PublishRequest | Represents the request during the publishing process. |
| PublishSource | Represents information about the source from which the content was published. |
| PublishTransaction | Represents the data object of a PublishTransaction. |
| PublishTransactionListInfo | Additional information for the entries in the list of Publish Transactions. |
| PublishTransactionsCreationResult | The result of the publish\un-publish operation |
| PublishUrlInfo | Represents information about publish url for specific publish purpose. |
| Region | Abstract base class for Regions. |
| RegionDefinition | Represents the data of a Region Definition in a Region Schema. |
| RegisteredType | Represents a base data class for types registered in the system |
| Repository | Represents a Repository: a context for BluePrinting. |
| RepositoryLocalObject | Abstract base class for the data of repository-local data objects: data objects that reside in a “Repository”. |
| ResolvedBundle | Represents a resolved Bundle: the actual Bundle and the subset of given items which are contained in it. |
| ResolvedItem | Represents the data object of a Resolved Item. |
| ResolveInstruction | Represents the instructions needed for resolving. |
| ResolveInstructionBase | Represents the base instructions needed for resolving. |
| RollBackRequest | Rolls back item version. |
| Schema | Represents the data of a Schema defining the structure of content and/or metadata. |
| SchemaInstance | Represents the instance data of a schema. |
| SearchFolder | Represents a Search Folder. |
| SearchQuery | Represents a data object of Search Query. |
| SecurityDescriptor | The SecurityDescriptorData is a grouping of all the Rights and Permissions (allow and denies) for the trustees. A SecurityDescriptorData is specific to a user and a context (IdentifiableObject). |
| Settings | Specifies settings in free form |
| SingleLineTextFieldDefinition | Represents a single-line text field definition (in a Schema). |
| SingleLineTextListDefinition | Provides information about whether/how to present a list of allowed single-line text field values. |
| StartWorkflowInstruction | Represents the data for a StartWorkflowInstruction. |
| StructureGroup | Represents the data of a Structure Group: an Organizational Item used to build the Publication’s target structure. |
| SynchronizationAction | Represents the data of a synchronization action of a Repository Local Object against its Schema. |
| SynchronizationResult | Represents the data of synchronization of item content and/or metadata with the current schema. |
| SystemPrivilege | Represents a system-wide privilege. |
| SystemPrivilegesDictionary | Represents a dictionary of the system-wide privilege keys associations with a collection of the Group’s link. |
| SystemWideObject | Abstract base class for the data of all system-wide objects. |
| TargetGroup | Represents the data of a Target Group: used to target an audience based on certain conditions. |
| TargetGroupCondition | Represents a condition on “membership” of a Target Group. |
| TargetLanguage | Represents a target language on a translation management system. |
| TargetPublication | Represent a Tridion Sites Publication where translated content will be stored. Each has a list of valid s. It is not possible to add or remove from the list of s. Instead the property can be changed to control if the is used. |
| TargetType | Represents the data of a Target Type used as a target for publishing. |
| TaxonomyNode | Represents a Taxonomy node, including its child nodes. The Taxonomy Root Node represents an (External) Category, child nodes represent (External) Keywords. |
| Template | Abstract base class for the data of Templates. |
| TemplateBuildingBlock | Represents the data of a Template Building Block: a re-usable template module. |
| TextFieldDefinition | Abstract base class for Text Field Definitions (specified in a Schema) |
| TmsLanguage | Represents a language on the translation management system. |
| TmsWorkflow | Represents a workflow defined on the translation management system. |
| TmsWorkflowStep | Represents a step in a {Tridion.TranslationManager.OpenApi.V3.Dto.TmsWorkflow}. |
| TrackingKeyCondition | Represents a condition on the value of a Tracking Key. |
| TranslationDetails | Contains information about the translation state of the Item. Created by calling {M:Tridion.TranslationManager.DomainModel.TmSession.GetTcmItemTranslationInfo(System.String)}. |
| TranslationInfo | Contains information about the translation state of the Item. |
| TranslationJob | Represents a Translation Job. |
| TranslationJobInfo | Contains details on a specific translation to a target Item (see {Tridion.TranslationManager.OpenApi.V3.Dto.TranslationInformation.TranslationDetails}). |
| TranslationJobOverview | Represents the basic information of a {Tridion.TranslationManager.OpenApi.V3.Dto.TranslationJob}. This is used when getting a list of {Tridion.TranslationManager.OpenApi.V3.Dto.TranslationJob}s where retrieving more data would slow down displaying the list. |
| TreeNode | |
| TridionActivityDefinition | Represents the data of a Tridion proprietary Activity Definition. |
| TridionProcessDefinition | Represents the data of a Tridion proprietary Process Definition. |
| Trustee | Abstract base class for the data of “Trustees”: the data of Users or Groups. |
| TypeConstraint | Represents a type constraint for Component Presentation(s) in Region Schema. |
| UndoCheckOutRequest | Removes permanent lock and reverts to last major version of the versioned item. |
| UnPublishInstruction | Represents the instructions needed for un-publishing an item. |
| UnPublishRequest | Represents the request during the un-publishing process. |
| UnPublishResolveInstruction | Represents the instructions needed for resolving. |
| User | Represents the data of a User. |
| UserLocaleInfo | Represents the information about User locale. |
| UserPreferences | Represents the User preferences data. |
| UserProfile | DTO for user profile. |
| UserRuntimeInfo | Represents the runtime information of the User. |
| ValidationError | Represents a validation error which is returned when validating an item. |
| ValidationResult | Represents the data of a validation result which is returned when validating an item. |
| ValidationWarning | Represents the data of a validation warning which is returned when validating an item. |
| VariablesDictionary | Represents multiple sets of variables grouped by name. |
| VersionedItem | Abstract base class for Versioned Items. Instances of this class represent a specific version of a Versioned Item. This version is either explicitly stated in the TCM URI (e.g. tcm:1-2-v3) or is implicitly the latest version. |
| VirtualFolder | Represents the data of a Virtual Folder: an Organizational Item that dynamically collects its contents. |
| WhereUsedListInfo | Additional information for the entries in a Where Used list. |
| WorkflowInfo | Represents workflow-related information for items that can participate in a workflow process. |
| WorkflowObject | Abstract Base class for the data of workflow items except for “ProcessDefinition” and “ApprovalStatus”. |
| WorkflowStatus | Contains information on which Items are in a specific the workflow step on the translation management system. |
| WorkflowType | Represents a data of Workflow Type.Different workflows are intended for different purposes (such as workflow process started automatically on editing item, project workflow where multiple items involved or task workflow process. The Workflow Type allows to distinguish workflow processes by their purpose. Predefined Workflow Types are: Unspecified (tcm:0-1-67584) (default), SystemStarted (tcm:0-2-67584) (set internally on saving of Component, Page, Component Template or Page Template if they have associated Process Definition) and Task (tcm:0-3-67584).Workflow types are read-only and can’t be created/modified/deleted through API. Custom workflow types can be registered in the Tridion.ContentManager.config in the workflowTypes section. |
| WorkItem | Represents the data of a Work Item: the association between an item participating in workflow and an Activity. |
| XhtmlFieldDefinition | Represents an XHTML field (a.k.a. Format Area) definition (in a Schema). |