Fuxsy-ADSKFusionManagePaid (Independent Publisher) (Preview)

For more information, visit: www.fuxsy.eu

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Fuxsy s.r.o.
URL	http://fuxsy.eu/
Email	support@fuxsy.eu

Connector Metadata
Publisher	Fuxsy.eu
Website	http://fuxsy.eu/
Privacy policy	http://fuxsy.eu/
Categories	Data;IT Operations

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Attachment Create	Creates or uploads a new attachment for a specific item.
Attachment Create Version	Creates a new version of an existing attachment.
Attachment Details	Retrieves detailed information about a specific attachment.
Attachment Folder Create	Creates a new attachment folder for a specific item.
Attachment List	Retrieves a list of all attachments for a specific item.
Groups Details	Retrieves detailed information about a specific group.
Groups List	Retrieves a list of all groups available in the tenant.
Item Change Log	Retrieves detailed information about changes made to a specific item.
Item Create	Creates a new item within a specific workspace.
Item Create Row	Creates a new row for a specific item within the grid.
Item Details	Retrieves detailed information about a specific item.
Item Details Fields List	Retrieves a list of all fields available on the Item Details tab.
Item Field Details	Displays detailed information about specified field within an item grid.
Item Field Types	Provides a list of all available field types.
Item Grid Row Update	Updates one or more rows for a specific item.
Item Grid Rows	Retrieves a list of rows and fields for a specific item, including their values.
Item List Fields	Retrieves a list of all fields within the grid.
Item Log	Retrieves detailed log information for a specific item.
Item Managed Items	Retrieves a list of managed items associated with a specific item.
Item Managed Items Create	Associates a new managed item with a specific item.
Item Managed Items List	Retrieves a list of managed items associated with a specific item.
Item PrintView	Generates a print view of a specific item.
Item PrintView List	Retrieves a list of available print views.
Item Relationship Item Create	Creates a new relationship for a specific item.
Item Relationship Item detail V1	Retrieves a list of relationships for a specific item.
Item Relationships list	Retrieves a list of all relationship items associated with a specific item.
Item Sections list	Retrieves a list of all sections on the Item Details tab.
Item Transition	Performs a transition on a specific item. Returns 403 even when successful.
Item Update Details	Updates the details of a specific item, removing any details that are not specified.
Item update Details - partial	Partially updates the details of a specific item, retaining any unspecified details.
Item Where Used	Retrieves a list of where the specific item is used.
Items Tab Overview	Retrieves a list of records and fields for a specific tab.
Permission Details	Retrieves detailed information about a specific permission.
Permission List	Retrieves a list of all permissions available in the tenant.
Picklist Details	Retrieves details of picklist lookups.
Report Details	Retrieves the complete configuration details of the report.
Report Download	Retrieves detailed information about a report/downloads the report
Script Create New	Creates a new script of the specified type.
Script Details	Retrieves the content and details of a specific script.
Script List	Retrieves a list of all scripts within the tenant.
Search value in whole tenant	Searches for a value across all items in the entire tenant.
Transitions available	Retrieves a list of available transitions for a specific item based on the logged-in user.
User Details	Retrieves detailed information about the specified user. If @me is used, the API will return details about the user making the API call.
User list of Permissions	Retrieves a list of all permissions assigned to a specific user.
User Outstanding Work	Retrieves outstanding work for the signed-in user via the API. The @me parameter is used to refer to the currently logged-in user, and it is not possible to choose a different user.
User Permission Detail	Retrieves the permission details for a specific user within a specific workspace, based on the provided permission ID.
User View Details	Retrieves detailed information about a specific user’s view.
User Views based access level	Retrieves a list of all user views (user-made filter of items inside a workspace).
Users In Group	Retrieves a list of users and their details for a specific group.
Users List	Retrieves a list of all users in the tenant with the option to filter by status.
Workspace Configured View List	Retrieves a list of all configured views for a specific workspace.
Workspace item Tabs List	Retrieves a list of all configured tabs for a specific workspace.
Workspace Items	Retrieves a list of all items within a specific workspace.
Workspace List	Retrieves a list of all workspaces in the tenant.
Workspace List Transitions	Retrieves a list of available transitions for a specific workspace.

Attachment Create

Operation ID:

attachmentCreateUpload

Creates or uploads a new attachment for a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace to retrieve details.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Attachment Create Version

Operation ID:

attachmentCreateVersion

Creates a new version of an existing attachment.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item containing the attachment.	ItemID	True	integer	The ID of the item containing the attachment can be obtained through the GET Item List API call.
Specifies the ID of the attachment to create a new version.	AttachmentID	True	integer	The ID of the attachment for which you want to create a new version can be obtained through the GET Attachments List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Attachment Details

Operation ID:

attachmentDetails

Retrieves detailed information about a specific attachment.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the item to retrieve details.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.
Specifies the ID of the attachment to retrieve details.	AttachmentID	True	integer	The ID of the attachment for which you want to retrieve details can be obtained through the GET Attachments List API call.

Returns

Name	Path	Type	Description
type	properties.fileUrl.type	string
type	type	string

Attachment Folder Create

Operation ID:

attachmentCreateFolder

Creates a new attachment folder for a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the ID of the item containing the attachment.	ItemID	True	integer	The ID of the item containing the attachment can be obtained through the GET Item List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Attachment List

Operation ID:

attachmentList

Retrieves a list of all attachments for a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace to retrieve details.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.
Specifies the field to sort results in ascending order.	asc		string	Specifies the field by which the results should be sorted in ascending order. For example, use 'name' to sort results by the name field in ascending order.
Specifies the media type expected in the response.	Accept		string	Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk attachment data in JSON format.

Returns

Name	Path	Type	Description
type	properties.attachments.items.properties.created.properties.timeStamp.type	string
type	properties.attachments.items.properties.created.properties.user.properties.email.type	string
type	properties.attachments.items.properties.created.properties.user.properties.image.properties.large.type	string
type	properties.attachments.items.properties.created.properties.user.properties.image.properties.medium.type	string
type	properties.attachments.items.properties.created.properties.user.properties.image.properties.small.type	string
type	properties.attachments.items.properties.created.properties.user.properties.image.type	string
type	properties.attachments.items.properties.created.properties.user.properties.link.type	string
type	properties.attachments.items.properties.created.properties.user.properties.status.type	string
type	properties.attachments.items.properties.created.properties.user.properties.title.type	string
type	properties.attachments.items.properties.created.properties.user.properties.urn.type	string
type	properties.attachments.items.properties.created.properties.user.type	string
type	properties.attachments.items.properties.created.type	string
type	properties.attachments.items.properties.description.type	string
type	properties.attachments.items.properties.folder.properties.id.type	string
type	properties.attachments.items.properties.folder.properties.name.type	string
type	properties.attachments.items.properties.folder.type	string
type	properties.attachments.items.properties.id.type	string
type	properties.attachments.items.properties.markups.properties.count.type	string
type	properties.attachments.items.properties.markups.properties.deleted.type	string
type	properties.attachments.items.properties.markups.properties.link.type	string
type	properties.attachments.items.properties.markups.type	string
type	properties.attachments.items.properties.name.type	string
type	properties.attachments.items.properties.resourceName.type	string
type	properties.attachments.items.properties.selfLink.type	string
type	properties.attachments.items.properties.size.type	string
type	properties.attachments.items.properties.status.properties.description.type	string
type	properties.attachments.items.properties.status.properties.label.type	string
type	properties.attachments.items.properties.status.properties.name.type	string
type	properties.attachments.items.properties.status.type	string
type	properties.attachments.items.properties.thumbnails.properties.large.type	string
type	properties.attachments.items.properties.thumbnails.properties.medium.type	string
type	properties.attachments.items.properties.thumbnails.properties.small.type	string
type	properties.attachments.items.properties.thumbnails.type	string
type	properties.attachments.items.properties.type.properties.extension.type	string
type	properties.attachments.items.properties.type.properties.fileType.type	string
type	properties.attachments.items.properties.type.properties.iconImage.type	string
type	properties.attachments.items.properties.type.properties.id.type	string
type	properties.attachments.items.properties.type.properties.viewable.type	string
type	properties.attachments.items.properties.type.type	string
type	properties.attachments.items.properties.url.type	string
type	properties.attachments.items.properties.urn.type	string
type	properties.attachments.items.properties.version.type	string
required	properties.attachments.items.required	array of string
type	properties.attachments.items.type	string
type	properties.attachments.type	string
type	properties.item.properties.deleted.type	string
type	properties.item.properties.link.type	string
type	properties.item.properties.title.type	string
type	properties.item.properties.urn.type	string
type	properties.item.type	string
type	type	string

Groups Details

Operation ID:

groupsDetails

Retrieves detailed information about a specific group.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the group to retrieve details.	GroupID	True	integer	The ID of the group for which you want to retrieve details can be obtained through the GET Groups List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.exclusiveGroup.type	string
type	properties.isSystemManaged.type	string
type	properties.mappedToOxygen.type	string
type	properties.minUserCount.type	string
type	properties.restrictIp.type	string
type	properties.shortName.type	string
type	properties.urn.type	string
type	type	string

Groups List

Operation ID:

groupsList

Retrieves a list of all groups available in the tenant.

Parameters

Name	Key	Required	Type	Description
Specifies the index to start retrieving items from a paginated result set.	offset		string	Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.
Sorts the results alphabetically in ascending or descending order.	sort		string	Sorts the results alphabetically either ascending or descending depending on specified value.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.groups.items.properties.__self__.type	string
type	properties.groups.items.properties.exclusiveGroup.type	string
type	properties.groups.items.properties.invariantName.type	string
type	properties.groups.items.properties.isSystemManaged.type	string
type	properties.groups.items.properties.longName.type	string
type	properties.groups.items.properties.mappedToOxygen.type	string
type	properties.groups.items.properties.minUserCount.type	string
type	properties.groups.items.properties.restrictIp.type	string
type	properties.groups.items.properties.shortName.type	string
type	properties.groups.items.properties.urn.type	string
required	properties.groups.items.required	array of string
type	properties.groups.items.type	string
type	properties.groups.type	string
type	type	string

Item Change Log

Operation ID:

itemChangeLog

Retrieves detailed information about changes made to a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve a log.	ItemID	True	integer	The ID of the item for which you want to retrieve a log of can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.__self__.type	string
longName	properties.items.items.properties.action.properties.longName	object
type	properties.items.items.properties.action.properties.notifyPermission.properties.deleted.type	string
type	properties.items.items.properties.action.properties.notifyPermission.properties.link.type	string
type	properties.items.items.properties.action.properties.notifyPermission.properties.title.type	string
type	properties.items.items.properties.action.properties.notifyPermission.properties.urn.type	string
type	properties.items.items.properties.action.properties.notifyPermission.type	string
type	properties.items.items.properties.action.properties.shortName.type	string
type	properties.items.items.properties.action.type	string
type	properties.items.items.properties.actionInvoker.type	string
type	properties.items.items.properties.description.type	string
fieldName	properties.items.items.properties.details.items.properties.fieldName	object
type	properties.items.items.properties.details.items.properties.newValue.type	string
oldValue	properties.items.items.properties.details.items.properties.oldValue	object
type	properties.items.items.properties.details.items.properties.type.properties.deleted.type	string
type	properties.items.items.properties.details.items.properties.type.properties.link.type	string
type	properties.items.items.properties.details.items.properties.type.properties.urn.type	string
type	properties.items.items.properties.details.items.properties.type.type	string
required	properties.items.items.properties.details.items.required	array of string
type	properties.items.items.properties.details.items.type	string
type	properties.items.items.properties.details.type	string
type	properties.items.items.properties.timeStamp.type	string
type	properties.items.items.properties.urn.type	string
type	properties.items.items.properties.user.properties.email.type	string
type	properties.items.items.properties.user.properties.image.properties.large.type	string
type	properties.items.items.properties.user.properties.image.properties.medium.type	string
type	properties.items.items.properties.user.properties.image.properties.small.type	string
type	properties.items.items.properties.user.properties.image.type	string
type	properties.items.items.properties.user.properties.link.type	string
type	properties.items.items.properties.user.properties.status.type	string
type	properties.items.items.properties.user.properties.title.type	string
type	properties.items.items.properties.user.properties.urn.type	string
type	properties.items.items.properties.user.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.next.properties.count.type	string
type	properties.next.properties.deleted.type	string
type	properties.next.properties.link.type	string
type	properties.next.properties.title.type	string
type	properties.next.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Item Create

Operation ID:

itemCreate

Creates a new item within a specific workspace.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for item creation.	WorkspaceID	True	integer	The ID of the workspace in which you want to create an item, can be obtained through the GET Workspace List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Item Create Row

Operation ID:

itemCreateGridRow

Creates a new row for a specific item within the grid.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item for creating a grid row.	ItemID	True	integer	The ID of the item for which you want to create a grid row, can be obtained through the GET Item List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Item Details

Operation ID:

itemDetails

Retrieves detailed information about a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.audit.properties.deleted.type	string
type	properties.audit.properties.link.type	string
type	properties.audit.type	string
type	properties.bom.properties.deleted.type	string
type	properties.bom.properties.link.type	string
type	properties.bom.type	string
type	properties.currentState.properties.deleted.type	string
type	properties.currentState.properties.link.type	string
type	properties.currentState.properties.title.type	string
type	properties.currentState.properties.urn.type	string
type	properties.currentState.type	string
type	properties.deleted.type	string
type	properties.flatBom.properties.deleted.type	string
type	properties.flatBom.properties.link.type	string
type	properties.flatBom.type	string
type	properties.itemLocked.type	string
type	properties.latestRelease.type	string
type	properties.lifecycle.properties.deleted.type	string
type	properties.lifecycle.properties.link.type	string
type	properties.lifecycle.properties.title.type	string
type	properties.lifecycle.properties.urn.type	string
type	properties.lifecycle.type	string
type	properties.milestones.properties.deleted.type	string
type	properties.milestones.properties.link.type	string
type	properties.milestones.type	string
type	properties.nestedBom.properties.count.type	string
type	properties.nestedBom.properties.deleted.type	string
type	properties.nestedBom.properties.link.type	string
type	properties.nestedBom.type	string
type	properties.owners.properties.deleted.type	string
type	properties.owners.properties.link.type	string
type	properties.owners.type	string
type	properties.revertible.type	string
type	properties.root.properties.deleted.type	string
type	properties.root.properties.link.type	string
type	properties.root.properties.title.type	string
type	properties.root.properties.urn.type	string
type	properties.root.type	string
type	properties.sections.items.properties.fields.items.properties.__self__.type	string
type	properties.sections.items.properties.fields.items.properties.defaultValue.type	string
type	properties.sections.items.properties.fields.items.properties.formulaField.type	string
type	properties.sections.items.properties.fields.items.properties.isSystemField.type	string
type	properties.sections.items.properties.fields.items.properties.title.type	string
type	properties.sections.items.properties.fields.items.properties.type.properties.deleted.type	string
type	properties.sections.items.properties.fields.items.properties.type.properties.link.type	string
type	properties.sections.items.properties.fields.items.properties.type.properties.title.type	string
type	properties.sections.items.properties.fields.items.properties.type.properties.urn.type	string
type	properties.sections.items.properties.fields.items.properties.type.type	string
type	properties.sections.items.properties.fields.items.properties.urn.type	string
type	properties.sections.items.properties.fields.items.properties.value.type	string
required	properties.sections.items.properties.fields.items.required	array of string
type	properties.sections.items.properties.fields.items.type	string
type	properties.sections.items.properties.fields.type	string
type	properties.sections.items.properties.link.type	string
type	properties.sections.items.properties.sectionLocked.type	string
type	properties.sections.items.properties.title.type	string
required	properties.sections.items.required	array of string
type	properties.sections.items.type	string
type	properties.sections.type	string
type	properties.sectionsLink.type	string
type	properties.title.type	string
type	properties.urn.type	string
type	properties.whereUsed.properties.count.properties.type.type	string
type	properties.whereUsed.properties.count.properties.value.type	string
type	properties.whereUsed.properties.count.type	string
type	properties.whereUsed.properties.link.type	string
type	properties.whereUsed.type	string
type	properties.workflowReference.type	string
type	properties.workingHasChanged.type	string
type	properties.workingVersion.type	string
type	properties.workspace.properties.deleted.type	string
type	properties.workspace.properties.link.type	string
type	properties.workspace.properties.title.type	string
type	properties.workspace.properties.type.type	string
type	properties.workspace.properties.urn.type	string
type	properties.workspace.type	string
type	type	string

Item Details Fields List

Operation ID:

itemDetailsFieldsList

Retrieves a list of all fields available on the Item Details tab.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for field details retrieval.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve field details can be obtained through the GET Workspace List API call.
Specifies the media type expected in the response.	Accept		string	Specifies the media type the client expects in the response. In this case, the client requests the response to be in the JSON format.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.fields.items.properties.__self__.type	string
type	properties.fields.items.properties.defaultValue.type	string
type	properties.fields.items.properties.derived.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.__self__.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.title.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.type.properties.deleted.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.type.properties.link.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.type.properties.title.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.type.properties.urn.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.type.type	string
type	properties.fields.items.properties.derivedFieldSource.properties.urn.type	string
type	properties.fields.items.properties.derivedFieldSource.type	string
type	properties.fields.items.properties.derivedFields.items.properties.__self__.type	string
type	properties.fields.items.properties.derivedFields.items.properties.title.type	string
type	properties.fields.items.properties.derivedFields.items.properties.type.properties.deleted.type	string
type	properties.fields.items.properties.derivedFields.items.properties.type.properties.link.type	string
type	properties.fields.items.properties.derivedFields.items.properties.type.properties.title.type	string
type	properties.fields.items.properties.derivedFields.items.properties.type.properties.urn.type	string
type	properties.fields.items.properties.derivedFields.items.properties.type.type	string
type	properties.fields.items.properties.derivedFields.items.properties.urn.type	string
required	properties.fields.items.properties.derivedFields.items.required	array of string
type	properties.fields.items.properties.derivedFields.items.type	string
type	properties.fields.items.properties.derivedFields.type	string
type	properties.fields.items.properties.description.type	string
displayLength	properties.fields.items.properties.displayLength	object
type	properties.fields.items.properties.displayOrder.type	string
type	properties.fields.items.properties.editability.type	string
fieldLength	properties.fields.items.properties.fieldLength	object
fieldPrecision	properties.fields.items.properties.fieldPrecision	object
fieldValidators	properties.fields.items.properties.fieldValidators	array of string
type	properties.fields.items.properties.formulaField.type	string
label	properties.fields.items.properties.label	object
type	properties.fields.items.properties.name.type	string
picklist	properties.fields.items.properties.picklist	object
picklistFieldDefinition	properties.fields.items.properties.picklistFieldDefinition	object
type	properties.fields.items.properties.pivotLink.type	string
type	properties.fields.items.properties.type.properties.deleted.type	string
type	properties.fields.items.properties.type.properties.link.type	string
type	properties.fields.items.properties.type.properties.title.type	string
type	properties.fields.items.properties.type.properties.urn.type	string
type	properties.fields.items.properties.type.type	string
unitOfMeasure	properties.fields.items.properties.unitOfMeasure	object
type	properties.fields.items.properties.urn.type	string
validators	properties.fields.items.properties.validators	object
type	properties.fields.items.properties.visibility.type	string
type	properties.fields.items.properties.visibleOnPreview.type	string
required	properties.fields.items.required	array of string
type	properties.fields.items.type	string
type	properties.fields.type	string
type	type	string

Item Field Details

Operation ID:

itemGridFieldDetails

Displays detailed information about specified field within an item grid.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the ID of the grid field for detail retrieval.	FieldID	True	integer	The ID of the grid field for which you want to retrieve details.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.defaultValue.type	string
type	properties.description.type	string
type	properties.label.type	string
type	properties.type.properties.deleted.type	string
type	properties.type.properties.link.type	string
type	properties.type.properties.title.type	string
type	properties.type.properties.urn.type	string
type	properties.type.type	string
type	properties.urn.type	string
type	type	string

Item Field Types

Operation ID:

itemDetailsFieldTypes

Provides a list of all available field types.

Returns

Name	Path	Type	Description
type	properties.field-types.items.properties.deleted.type	string
type	properties.field-types.items.properties.link.type	string
type	properties.field-types.items.properties.title.type	string
type	properties.field-types.items.properties.urn.type	string
required	properties.field-types.items.required	array of string
type	properties.field-types.items.type	string
type	properties.field-types.type	string
type	type	string

Item Grid Row Update

Operation ID:

itemGridRowUpdate

Updates one or more rows for a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the ID of the item containing the grid tab.	ItemID	True	integer	The ID of the item containing the grid tab can be obtained through the GET Item List API call.
Specifies the ID of the row to update.	RowID	True	integer	The ID of the row that you want to update.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Item Grid Rows

Operation ID:

itemGridRows

Retrieves a list of rows and fields for a specific item, including their values.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.aggregations.items.properties.__self__.type	string
type	properties.aggregations.items.properties.isSystemField.type	string
type	properties.aggregations.items.properties.title.type	string
type	properties.aggregations.items.properties.type.properties.deleted.type	string
type	properties.aggregations.items.properties.type.properties.link.type	string
type	properties.aggregations.items.properties.type.properties.title.type	string
type	properties.aggregations.items.properties.type.properties.urn.type	string
type	properties.aggregations.items.properties.type.type	string
type	properties.aggregations.items.properties.urn.type	string
type	properties.aggregations.items.properties.value.type	string
required	properties.aggregations.items.required	array of string
type	properties.aggregations.items.type	string
type	properties.aggregations.type	string
properties	properties.rows.items.properties.metaFieldTableBean.properties.dataMap.properties	object
type	properties.rows.items.properties.metaFieldTableBean.properties.dataMap.type	string
type	properties.rows.items.properties.metaFieldTableBean.type	string
type	properties.rows.items.properties.rowData.items.properties.__self__.type	string
type	properties.rows.items.properties.rowData.items.properties.formulaField.type	string
type	properties.rows.items.properties.rowData.items.properties.isSystemField.type	string
type	properties.rows.items.properties.rowData.items.properties.title.type	string
type	properties.rows.items.properties.rowData.items.properties.type.properties.deleted.type	string
type	properties.rows.items.properties.rowData.items.properties.type.properties.link.type	string
type	properties.rows.items.properties.rowData.items.properties.type.properties.urn.type	string
type	properties.rows.items.properties.rowData.items.properties.type.type	string
type	properties.rows.items.properties.rowData.items.properties.urn.type	string
type	properties.rows.items.properties.rowData.items.properties.value.type	string
required	properties.rows.items.properties.rowData.items.required	array of string
type	properties.rows.items.properties.rowData.items.type	string
type	properties.rows.items.properties.rowData.type	string
type	properties.rows.items.properties.rowID.type	string
required	properties.rows.items.required	array of string
type	properties.rows.items.type	string
type	properties.rows.type	string
type	type	string

Item List Fields

Operation ID:

itemGridFieldsList

Retrieves a list of all fields within the grid.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for grid field details retrieval.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve grid field details can be obtained through the GET Workspace List API call.
Specifies the media type expected in the response.	Accept		string	Specifies the media type the client expects in the response. In this case, the client requests the response to be in the JSON format.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.fields.items.properties.__self__.type	string
defaultValue	properties.fields.items.properties.defaultValue	object
type	properties.fields.items.properties.derived.type	string
type	properties.fields.items.properties.description.type	string
type	properties.fields.items.properties.displayLength.type	string
type	properties.fields.items.properties.displayOrder.type	string
type	properties.fields.items.properties.editability.type	string
fieldLength	properties.fields.items.properties.fieldLength	object
fieldPrecision	properties.fields.items.properties.fieldPrecision	object
fieldValidators	properties.fields.items.properties.fieldValidators	object
type	properties.fields.items.properties.formulaField.type	string
properties	properties.fields.items.properties.gridFieldAggregationInfo.properties	object
type	properties.fields.items.properties.gridFieldAggregationInfo.type	string
label	properties.fields.items.properties.label	object
type	properties.fields.items.properties.name.type	string
type	properties.fields.items.properties.picklist.type	string
type	properties.fields.items.properties.picklistFieldDefinition.type	string
type	properties.fields.items.properties.type.properties.deleted.type	string
type	properties.fields.items.properties.type.properties.link.type	string
type	properties.fields.items.properties.type.properties.title.type	string
type	properties.fields.items.properties.type.properties.urn.type	string
type	properties.fields.items.properties.type.type	string
unitOfMeasure	properties.fields.items.properties.unitOfMeasure	object
type	properties.fields.items.properties.urn.type	string
validators	properties.fields.items.properties.validators	object
type	properties.fields.items.properties.visibility.type	string
visibleOnPreview	properties.fields.items.properties.visibleOnPreview	object
required	properties.fields.items.required	array of string
type	properties.fields.items.type	string
type	properties.fields.type	string
type	type	string

Item Log

Operation ID:

itemLog

Retrieves detailed log information for a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item for which to retrieve a log.	ItemID	True	integer	The ID of the item for which you want to retrieve a log of can be obtained through the GET Item List API call.
Specifies the starting index for retrieving items in a paginated result set.	offset		string	Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.
Specifies the field to sort results in ascending order.	asc		string	Specifies the field by which the results should be sorted in ascending order. For example, using 'timeStamp' will sort the results based on the time they were created or modified.
Specifies the field to sort results in descending order.	desc		string	Specifies the field by which the results should be sorted in descending order. For example, using 'timeStamp' will sort the results based on the time they were created or modified.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.__self__.type	string
longName	properties.items.items.properties.action.properties.longName	object
notifyPermission	properties.items.items.properties.action.properties.notifyPermission	object
type	properties.items.items.properties.action.properties.shortName.type	string
type	properties.items.items.properties.action.type	string
type	properties.items.items.properties.actionInvoker.type	string
type	properties.items.items.properties.description.type	string
type	properties.items.items.properties.details.type	string
type	properties.items.items.properties.timeStamp.type	string
type	properties.items.items.properties.urn.type	string
type	properties.items.items.properties.user.properties.email.type	string
type	properties.items.items.properties.user.properties.image.properties.large.type	string
type	properties.items.items.properties.user.properties.image.properties.medium.type	string
type	properties.items.items.properties.user.properties.image.properties.small.type	string
type	properties.items.items.properties.user.properties.image.type	string
type	properties.items.items.properties.user.properties.link.type	string
type	properties.items.items.properties.user.properties.status.type	string
type	properties.items.items.properties.user.properties.title.type	string
type	properties.items.items.properties.user.properties.urn.type	string
type	properties.items.items.properties.user.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.next.properties.count.type	string
type	properties.next.properties.deleted.type	string
type	properties.next.properties.link.type	string
type	properties.next.properties.title.type	string
type	properties.next.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Item Managed Items

Operation ID:

managedItems

Retrieves a list of managed items associated with a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace to retrieve details.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.affectedItems.items.properties.__self__.type	string
type	properties.affectedItems.items.properties.item.properties.deleted.type	string
type	properties.affectedItems.items.properties.item.properties.link.type	string
type	properties.affectedItems.items.properties.item.properties.title.type	string
type	properties.affectedItems.items.properties.item.properties.urn.type	string
type	properties.affectedItems.items.properties.item.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.title.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.uom.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.urn.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.value.type	string
required	properties.affectedItems.items.properties.linkedFields.items.required	array of string
type	properties.affectedItems.items.properties.linkedFields.items.type	string
type	properties.affectedItems.items.properties.linkedFields.type	string
type	properties.affectedItems.items.properties.type.type	string
type	properties.affectedItems.items.properties.urn.type	string
required	properties.affectedItems.items.required	array of string
type	properties.affectedItems.items.type	string
type	properties.affectedItems.type	string
type	type	string

Item Managed Items Create

Operation ID:

createManagedItem

Associates a new managed item with a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item containing the managed item's tab.	ItemID	True	integer	The ID of the item containing the managed item's tab can be obtained through the GET Item List API call.
Specifies the media type expected in the response.	Accept		string	Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk affected items data in JSON format.
request123	request123

Item Managed Items List

Operation ID:

itemManagedItemsList

Retrieves a list of managed items associated with a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item containing the managed item's tab.	ItemID	True	integer	The ID of the item containing the managed item's tab can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.affectedItems.items.properties.__self__.type	string
type	properties.affectedItems.items.properties.item.properties.deleted.type	string
type	properties.affectedItems.items.properties.item.properties.link.type	string
type	properties.affectedItems.items.properties.item.properties.title.type	string
type	properties.affectedItems.items.properties.item.properties.urn.type	string
type	properties.affectedItems.items.properties.item.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.title.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.type.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.uom.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.urn.type	string
type	properties.affectedItems.items.properties.linkedFields.items.properties.value.type	string
required	properties.affectedItems.items.properties.linkedFields.items.required	array of string
type	properties.affectedItems.items.properties.linkedFields.items.type	string
type	properties.affectedItems.items.properties.linkedFields.type	string
type	properties.affectedItems.items.properties.type.type	string
type	properties.affectedItems.items.properties.urn.type	string
required	properties.affectedItems.items.required	array of string
type	properties.affectedItems.items.type	string
type	properties.affectedItems.type	string
type	type	string

Item PrintView

Operation ID:

itemPrintView

Generates a print view of a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the ID of the item for creating a print view.	ItemID	True	integer	The ID of the item for which you create a printview, can be obtained through the GET Item List API call.
Specifies the ID of the Printview.	PrintViewID	True	string	The ID of the Printview, example: 'APV-123'

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.hide.type	string
type	properties.printName.type	string
type	properties.urn.type	string
type	type	string

Item PrintView List

Operation ID:

itemPrintViewsList

Retrieves a list of available print views.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for retrieving the print views list.	WorkspaceID	True	integer	The ID of the workspace for which you want to printviews list can be obtained through the GET Workspace List API call.
Indicates whether to sort results in ascending order.	asc		string	Indicates whether the results should be sorted in ascending order. Use 'true' for ascending or leave it blank for default sorting.
Indicates whether to sort results in descending order.	desc		string	Indicates whether the results should be sorted in descending order. Use 'true' for descending or leave it blank for default sorting.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.links.items.properties.deleted.type	string
type	properties.links.items.properties.hidden.type	string
type	properties.links.items.properties.link.type	string
type	properties.links.items.properties.title.type	string
type	properties.links.items.properties.type.type	string
type	properties.links.items.properties.urn.type	string
required	properties.links.items.required	array of string
type	properties.links.items.type	string
type	properties.links.type	string
type	type	string

Item Relationship Item Create

Operation ID:

itemCreateRelationships

Creates a new relationship for a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item for creating a new relationship.	ItemID	True	integer	The ID of the item for which you create a new relationship (link it with another item), can be obtained through the GET Item List API call.
Specifies the location of a specific item within a workspace.	content-location		string	Specifies the location of a specific item within a workspace. The value contains placeholders like :WorkspaceID and :ItemID, which need to be replaced with actual IDs.
request123	request123

Item Relationship Item detail V1

Operation ID:

itemRelationshipsList

Retrieves a list of relationships for a specific item.

Parameters

Name	Key	Required	Type	Description
Indicates the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Indicates the ID of the item to retrieve relationship details.	ItemID	True	integer	The ID of the item for which you want to retrieve relationship details of can be obtained through the GET Item List API call.
Specifies the page number for result retrieval.	page		string	Specifies the page number of the results to retrieve. Used for paginating through large datasets.
Specifies the number of items per page in a paginated response.	size		string	Specifies the number of items to return per page in a paginated response. This allows clients to control the size of the result set.
Specifies the field used to sort the results.	sort		string	Specifies the field by which to sort the results. Example: 'createdOn' for sorting by creation date.
Specifies the sorting direction of the results.	sortDirection		string	Specifies the sorting direction. Use 'ASC' for ascending and 'DESC' for descending. Example: 'ASC' to sort in ascending order.

Returns

Name	Path	Type	Description
type	properties.list.properties.item-relationship.items.properties.description.type	string
type	properties.list.properties.item-relationship.items.properties.direction.properties.label.type	string
type	properties.list.properties.item-relationship.items.properties.direction.properties.value.type	string
type	properties.list.properties.item-relationship.items.properties.direction.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.description.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.deleted.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.dmsID.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.latest.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.effectivity.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateID.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateName.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.timeStamp.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.version.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.versionID.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateId.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateName.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.working.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workspaceID.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.details.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.id.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.dataType.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.value.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.key.type	string
required	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.required	array of string
type	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.metaFields.type	string
type	properties.list.properties.item-relationship.items.properties.item.properties.uri.type	string
type	properties.list.properties.item-relationship.items.properties.item.type	string
type	properties.list.properties.item-relationship.items.properties.type.properties.label.type	string
type	properties.list.properties.item-relationship.items.properties.type.properties.value.type	string
type	properties.list.properties.item-relationship.items.properties.type.type	string
required	properties.list.properties.item-relationship.items.required	array of string
type	properties.list.properties.item-relationship.items.type	string
type	properties.list.properties.item-relationship.type	string
type	properties.list.type	string
type	type	string

Item Relationships list

Operation ID:

itemRelationships

Retrieves a list of all relationship items associated with a specific item.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item containing the relationships tab.	ItemID	True	integer	The ID of the item containing the relationships tab can be obtained through the GET Item List API call.

Returns

Items

ApiV3Workspaces-WorkspaceID-Items-ItemID-Views10Get200ApplicationJsonResponse

Item Sections list

Operation ID:

itemDetailSections

Retrieves a list of all sections on the Item Details tab.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for retrieving item details sections.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve item details sections configuration, can be obtained through the GET Workspace List API call.

Returns

Items

200_sections

Item Transition

Operation ID:

itemTransition

Performs a transition on a specific item. Returns 403 even when successful.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item for performing a transition.	ItemID	True	integer	The ID of the item on which you want to perform a transition, can be obtained through the GET Item List API call.
Specifies the ID of the workflow transition to perform.	WorkflowID	True	integer	The ID of the workflow transition that you want to perform.
Specifies the location of the resource or content.	content-location	True	string	Specifies the location of the resource or content. This must be a valid URL or path to where the content is hosted or retrieved from.
request123	request123

Item Update Details

Operation ID:

updateItemDetails

Updates the details of a specific item, removing any details that are not specified.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item to update details.	ItemID	True	integer	The ID of the item for which you want to update item details, can be obtained through the GET Item List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Item update Details - partial

Operation ID:

updateItemDetailsPartial

Partially updates the details of a specific item, retaining any unspecified details.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item to update details.	ItemID	True	integer	The ID of the item for which you want to update item details, can be obtained through the GET Item List API call.
Indicates the media type of the request body.	Content-Type		string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Item Where Used

Operation ID:

itemWhereUsed

Retrieves a list of where the specific item is used.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the ID of the item used in the BOM.	ItemID	True	integer	The ID of the item used in BOM, can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.config.properties.bias.type	string
type	properties.config.properties.bomViewDate.type	string
type	properties.config.properties.viewDef.properties.deleted.type	string
type	properties.config.properties.viewDef.properties.link.type	string
type	properties.config.properties.viewDef.properties.urn.type	string
type	properties.config.properties.viewDef.type	string
type	properties.config.type	string
type	properties.edges.items.properties.child.type	string
type	properties.edges.items.properties.depth.type	string
type	properties.edges.items.properties.edgeId.type	string
type	properties.edges.items.properties.edgeLink.type	string
fields	properties.edges.items.properties.fields	array of string
type	properties.edges.items.properties.itemNumber.type	string
type	properties.edges.items.properties.lastNode.type	string
type	properties.edges.items.properties.parent.type	string
required	properties.edges.items.required	array of string
type	properties.edges.items.type	string
type	properties.edges.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.nodes.items.properties.bomItems.type	string
type	properties.nodes.items.properties.bomRoot.type	string
type	properties.nodes.items.properties.fields.items.properties.isSystemField.type	string
type	properties.nodes.items.properties.fields.items.properties.title.type	string
type	properties.nodes.items.properties.fields.items.properties.value.type	string
required	properties.nodes.items.properties.fields.items.required	array of string
type	properties.nodes.items.properties.fields.items.type	string
type	properties.nodes.items.properties.fields.type	string
type	properties.nodes.items.properties.item.properties.deleted.type	string
type	properties.nodes.items.properties.item.properties.link.type	string
type	properties.nodes.items.properties.item.properties.title.type	string
type	properties.nodes.items.properties.item.properties.urn.type	string
type	properties.nodes.items.properties.item.properties.version.type	string
type	properties.nodes.items.properties.item.type	string
required	properties.nodes.items.required	array of string
type	properties.nodes.items.type	string
type	properties.nodes.type	string
type	properties.offset.type	string
type	properties.root.type	string
type	properties.totalCount.type	string
type	type	string

Items Tab Overview

Operation ID:

itemTabOverview

Retrieves a list of records and fields for a specific tab.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item for retrieving records and fields for a tab/view.	ItemID	True	integer	The ID of the item for which you want to retrieve a list of records and fields for a specific tab/view, can be obtained through the GET Item List API call.
Specifies the ID of the tab/view for details retrieval.	ViewID	True	integer	The ID of the tab/view for which you want to retrieve details.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.__self__.type	string
longName	properties.items.items.properties.action.properties.longName	object
notifyPermission	properties.items.items.properties.action.properties.notifyPermission	object
type	properties.items.items.properties.action.properties.shortName.type	string
type	properties.items.items.properties.action.type	string
type	properties.items.items.properties.actionInvoker.type	string
type	properties.items.items.properties.description.type	string
type	properties.items.items.properties.details.type	string
type	properties.items.items.properties.timeStamp.type	string
type	properties.items.items.properties.urn.type	string
type	properties.items.items.properties.user.properties.email.type	string
type	properties.items.items.properties.user.properties.image.properties.large.type	string
type	properties.items.items.properties.user.properties.image.properties.medium.type	string
type	properties.items.items.properties.user.properties.image.properties.small.type	string
type	properties.items.items.properties.user.properties.image.type	string
type	properties.items.items.properties.user.properties.link.type	string
type	properties.items.items.properties.user.properties.status.type	string
type	properties.items.items.properties.user.properties.title.type	string
type	properties.items.items.properties.user.properties.urn.type	string
type	properties.items.items.properties.user.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Permission Details

Operation ID:

permissionDetails

Retrieves detailed information about a specific permission.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the permission to retrieve details.	PermissionID	True	integer	The ID of the permission for which you want to retrieve details can be obtained through the GET Permission List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.id.type	string
type	properties.longName.type	string
type	properties.shortName.type	string
type	properties.urn.type	string
type	type	string

Permission List

Operation ID:

permissionsList

Retrieves a list of all permissions available in the tenant.

Returns

Name	Path	Type	Description
type	properties.permissions.items.properties.deleted.type	string
type	properties.permissions.items.properties.link.type	string
type	properties.permissions.items.properties.name.type	string
type	properties.permissions.items.properties.title.type	string
type	properties.permissions.items.properties.urn.type	string
required	properties.permissions.items.required	array of string
type	properties.permissions.items.type	string
type	properties.permissions.type	string
type	type	string

Picklist Details

Operation ID:

picklistLookups

Retrieves details of picklist lookups.

Parameters

Name	Key	Required	Type	Description
Specifies the Custom ID of the Picklist/Lookup for detail retrieval.	PicklistID	True	string	The Custom ID of the Picklist/Lookup you want to retrieve details for.
Specifies the starting index for retrieving items in a paginated result set.	offset		string	Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.properties.urn.type	string
type	properties.first.type	string
type	properties.items.items.properties.link.type	string
type	properties.items.items.properties.title.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.properties.urn.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	properties.urn.type	string
type	type	string

Report Details

Operation ID:

reportDetails

Retrieves the complete configuration details of the report.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the report to retrieve details.	ReportID	True	integer	The ID of the report that you want to retrieve details of.

Returns

Name	Path	Type	Description
type	properties.reportDefinition.properties.hasOrphanFields.type	string
type	properties.reportDefinition.properties.id.type	string
type	properties.reportDefinition.properties.isChartReport.type	string
type	properties.reportDefinition.properties.modifiedDate.type	string
type	properties.reportDefinition.properties.name.type	string
type	properties.reportDefinition.properties.owner.type	string
type	properties.reportDefinition.properties.workspaceId.type	string
type	properties.reportDefinition.type	string
type	properties.reportResult.properties.columnKey.items.properties.label.type	string
type	properties.reportResult.properties.columnKey.items.properties.value.type	string
required	properties.reportResult.properties.columnKey.items.required	array of string
type	properties.reportResult.properties.columnKey.items.type	string
type	properties.reportResult.properties.columnKey.type	string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.dataType.type	string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.label.type	string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.value.type	string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.type	string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.key.type	string
required	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.required	array of string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.items.type	string
type	properties.reportResult.properties.row.items.properties.fields.properties.entry.type	string
type	properties.reportResult.properties.row.items.properties.fields.type	string
type	properties.reportResult.properties.row.items.properties.rowId.type	string
required	properties.reportResult.properties.row.items.required	array of string
type	properties.reportResult.properties.row.items.type	string
type	properties.reportResult.properties.row.type	string
type	properties.reportResult.properties.totalResultCount.type	string
type	properties.reportResult.type	string
type	type	string

Report Download

Operation ID:

reportDownload

Retrieves detailed information about a report/downloads the report

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace to retrieve details.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.
Specifies the ID of the report to download.	ReportID	True	integer	The ID of the report that you want to download.
Specifies the page number of the results to retrieve.	page		string	Specifies the page number of the results to retrieve. Used for paginating through large datasets.
Specifies the field to sort results in ascending order.	asc		string	Specifies the field by which the results should be sorted in ascending order.
Specifies the field to sort results in descending order.	desc		string	Specifies the field by which the results should be sorted in descending order.
Specifies the number of items to return per page in a paginated response.	size		string	Specifies the number of items to return per page in a paginated response. This allows clients to control the size of the result set.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.columns.items.properties.displayName.type	string
type	properties.columns.items.properties.id.type	string
type	properties.columns.items.properties.index.type	string
required	properties.columns.items.required	array of string
type	properties.columns.items.type	string
type	properties.columns.type	string
type	properties.items.items.properties.fields.items.properties.id.type	string
type	properties.items.items.properties.fields.items.properties.value.type	string
required	properties.items.items.properties.fields.items.required	array of string
type	properties.items.items.properties.fields.items.type	string
type	properties.items.items.properties.fields.type	string
type	properties.items.items.properties.index.type	string
type	properties.items.items.properties.item.properties.deleted.type	string
type	properties.items.items.properties.item.properties.link.type	string
type	properties.items.items.properties.item.properties.urn.type	string
type	properties.items.items.properties.item.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.pageNumber.type	string
type	properties.pageSize.type	string
type	properties.sortingColumns.items.properties.id.type	string
type	properties.sortingColumns.items.properties.index.type	string
type	properties.sortingColumns.items.properties.order.type	string
required	properties.sortingColumns.items.required	array of string
type	properties.sortingColumns.items.type	string
type	properties.sortingColumns.type	string
type	properties.total.type	string
type	properties.urn.type	string
type	type	string

Script Create New

Operation ID:

scriptCreate

Creates a new script of the specified type.

Parameters

Name	Key	Required	Type	Description
Indicates the media type of the request body.	Content-Type	True	string	Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.
request123	request123

Script Details

Operation ID:

scriptDetails

Retrieves the content and details of a specific script.

Parameters

Name	Key	Required	Type	Description
Specifies the unique identifier of the script.	ScriptID	True	integer	The unique identifier of the script to retrieve or manipulate. This is a required parameter, and you must provide a valid ScriptID as an integer in the request path.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.code.type	string
dependsOn	properties.dependsOn	array of string
type	properties.displayName.type	string
type	properties.scriptType.type	string
type	properties.uniqueName.type	string
type	properties.urn.type	string
type	properties.version.type	string
type	type	string

Script List

Operation ID:

scriptList

Retrieves a list of all scripts within the tenant.

Parameters

Name	Key	Required	Type	Description
Specifies the field to order the results.	orderBy		string	Specifies the field by which the results should be ordered. For example, using 'scriptType' will order the results based on the type of script. This parameter works in conjunction with 'asc' or 'desc' to define the sorting direction.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.scripts.items.properties.__self__.type	string
type	properties.scripts.items.properties.dependsOn.items.properties.deleted.type	string
type	properties.scripts.items.properties.dependsOn.items.properties.link.type	string
type	properties.scripts.items.properties.dependsOn.items.properties.title.type	string
type	properties.scripts.items.properties.dependsOn.items.properties.urn.type	string
required	properties.scripts.items.properties.dependsOn.items.required	array of string
type	properties.scripts.items.properties.dependsOn.items.type	string
type	properties.scripts.items.properties.dependsOn.type	string
type	properties.scripts.items.properties.displayName.type	string
type	properties.scripts.items.properties.scriptType.type	string
type	properties.scripts.items.properties.uniqueName.type	string
type	properties.scripts.items.properties.urn.type	string
type	properties.scripts.items.properties.version.type	string
required	properties.scripts.items.required	array of string
type	properties.scripts.items.type	string
type	properties.scripts.type	string
type	type	string

Search value in whole tenant

Operation ID:

searchInTenant

Searches for a value across all items in the entire tenant.

Parameters

Name	Key	Required	Type	Description
Specifies the search term for querying tenant data.	query		string	The search term to be used for querying the tenant's data.
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.
Specifies the sorting order for the results.	sort		string	Specifies the sorting order for the results. Use 'asc' for ascending and 'desc' for descending. Example: 'createdOn asc' for sorting by creation date in ascending order.
Specifies the media type expected in the response.	Accept		string	Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk items data in JSON format.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.__self__.type	string
type	properties.items.items.properties.audit.properties.deleted.type	string
type	properties.items.items.properties.audit.properties.link.type	string
type	properties.items.items.properties.audit.type	string
type	properties.items.items.properties.bom.properties.deleted.type	string
type	properties.items.items.properties.bom.properties.link.type	string
type	properties.items.items.properties.bom.type	string
type	properties.items.items.properties.currentState.properties.deleted.type	string
type	properties.items.items.properties.currentState.properties.link.type	string
type	properties.items.items.properties.currentState.properties.title.type	string
type	properties.items.items.properties.currentState.properties.urn.type	string
type	properties.items.items.properties.currentState.type	string
type	properties.items.items.properties.deleted.type	string
type	properties.items.items.properties.flatBom.properties.deleted.type	string
type	properties.items.items.properties.flatBom.properties.link.type	string
type	properties.items.items.properties.flatBom.type	string
type	properties.items.items.properties.itemLocked.type	string
type	properties.items.items.properties.latestRelease.type	string
type	properties.items.items.properties.lifecycle.properties.deleted.type	string
type	properties.items.items.properties.lifecycle.properties.link.type	string
type	properties.items.items.properties.lifecycle.properties.title.type	string
type	properties.items.items.properties.lifecycle.properties.urn.type	string
type	properties.items.items.properties.lifecycle.type	string
type	properties.items.items.properties.milestones.properties.deleted.type	string
type	properties.items.items.properties.milestones.properties.link.type	string
type	properties.items.items.properties.milestones.type	string
type	properties.items.items.properties.nestedBom.properties.count.type	string
type	properties.items.items.properties.nestedBom.properties.deleted.type	string
type	properties.items.items.properties.nestedBom.properties.link.type	string
type	properties.items.items.properties.nestedBom.type	string
type	properties.items.items.properties.owners.properties.deleted.type	string
type	properties.items.items.properties.owners.properties.link.type	string
type	properties.items.items.properties.owners.type	string
type	properties.items.items.properties.root.properties.deleted.type	string
type	properties.items.items.properties.root.properties.link.type	string
type	properties.items.items.properties.root.properties.title.type	string
type	properties.items.items.properties.root.properties.urn.type	string
type	properties.items.items.properties.root.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.title.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.value.type	string
required	properties.items.items.properties.sections.items.properties.fields.items.required	array of string
type	properties.items.items.properties.sections.items.properties.fields.items.type	string
type	properties.items.items.properties.sections.items.properties.fields.type	string
type	properties.items.items.properties.sections.items.properties.link.type	string
type	properties.items.items.properties.sections.items.properties.sectionLocked.type	string
type	properties.items.items.properties.sections.items.properties.title.type	string
required	properties.items.items.properties.sections.items.required	array of string
type	properties.items.items.properties.sections.items.type	string
type	properties.items.items.properties.sections.type	string
type	properties.items.items.properties.sectionsLink.type	string
type	properties.items.items.properties.title.type	string
type	properties.items.items.properties.urn.type	string
type	properties.items.items.properties.whereUsed.properties.count.properties.type.type	string
type	properties.items.items.properties.whereUsed.properties.count.properties.value.type	string
type	properties.items.items.properties.whereUsed.properties.count.type	string
type	properties.items.items.properties.whereUsed.properties.link.type	string
type	properties.items.items.properties.whereUsed.type	string
type	properties.items.items.properties.workflowReference.type	string
type	properties.items.items.properties.workingHasChanged.type	string
type	properties.items.items.properties.workingVersion.type	string
type	properties.items.items.properties.workspace.properties.deleted.type	string
type	properties.items.items.properties.workspace.properties.link.type	string
type	properties.items.items.properties.workspace.properties.title.type	string
type	properties.items.items.properties.workspace.properties.type.type	string
type	properties.items.items.properties.workspace.properties.urn.type	string
type	properties.items.items.properties.workspace.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Transitions available

Operation ID:

itemTransitionsAvailable

Retrieves a list of available transitions for a specific item based on the logged-in user.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for retrieving available transitions.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve a list of available transitions, can be obtained through the GET Workspace List API call.

Returns

Name	Path	Type	Description
type	items.properties.__self__.type	string
type	items.properties.actionScript.properties.deleted.type	string
type	items.properties.actionScript.properties.link.type	string
type	items.properties.actionScript.properties.title.type	string
type	items.properties.actionScript.properties.urn.type	string
type	items.properties.actionScript.type	string
approvers	items.properties.approvers	array of string
type	items.properties.comments.type	string
type	items.properties.conditionScript.properties.deleted.type	string
type	items.properties.conditionScript.properties.link.type	string
type	items.properties.conditionScript.properties.title.type	string
type	items.properties.conditionScript.properties.urn.type	string
type	items.properties.conditionScript.type	string
type	items.properties.customLabel.type	string
delegatorUsers	items.properties.delegatorUsers	array of string
type	items.properties.escalationPermission.properties.deleted.type	string
type	items.properties.escalationPermission.properties.link.type	string
type	items.properties.escalationPermission.properties.title.type	string
type	items.properties.escalationPermission.properties.urn.type	string
type	items.properties.escalationPermission.type	string
type	items.properties.fromState.properties.deleted.type	string
type	items.properties.fromState.properties.link.type	string
type	items.properties.fromState.properties.title.type	string
type	items.properties.fromState.properties.urn.type	string
type	items.properties.fromState.type	string
type	items.properties.hidden.type	string
type	items.properties.ignoreEscalatedPreconditions.type	string
type	items.properties.labelPositionA.type	string
type	items.properties.labelPositionB.type	string
type	items.properties.name.type	string
type	items.properties.notifyPerformers.type	string
type	items.properties.passwordEnabled.type	string
type	items.properties.permission.properties.deleted.type	string
type	items.properties.permission.properties.link.type	string
type	items.properties.permission.properties.title.type	string
type	items.properties.permission.properties.urn.type	string
type	items.properties.permission.type	string
points	items.properties.points	object
type	items.properties.sendEmail.type	string
type	items.properties.showInOutstanding.type	string
type	items.properties.toState.properties.deleted.type	string
type	items.properties.toState.properties.link.type	string
type	items.properties.toState.properties.title.type	string
type	items.properties.toState.properties.urn.type	string
type	items.properties.toState.type	string
type	items.properties.urn.type	string
type	items.properties.validationScript.properties.deleted.type	string
type	items.properties.validationScript.properties.link.type	string
type	items.properties.validationScript.properties.title.type	string
type	items.properties.validationScript.properties.urn.type	string
type	items.properties.validationScript.type	string
type	items.properties.workspace.properties.deleted.type	string
type	items.properties.workspace.properties.link.type	string
type	items.properties.workspace.properties.title.type	string
type	items.properties.workspace.properties.type.type	string
type	items.properties.workspace.properties.urn.type	string
type	items.properties.workspace.type	string
required	items.required	array of string
type	items.type	string
type	type	string

User Details

Operation ID:

userDetails

Retrieves detailed information about the specified user. If @me is used, the API will return details about the user making the API call.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the user to retrieve details.	UserID	True	string	The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
aboutMe	properties.aboutMe	object
type	properties.active.type	string
type	properties.address1.type	string
type	properties.address2.type	string
type	properties.alerts.items.properties.acknowledged.type	string
type	properties.alerts.items.properties.deleted.type	string
type	properties.alerts.items.properties.link.type	string
type	properties.alerts.items.properties.message.type	string
type	properties.alerts.items.properties.priority.type	string
type	properties.alerts.items.properties.title.type	string
type	properties.alerts.items.properties.type.type	string
type	properties.alerts.items.properties.urgent.type	string
type	properties.alerts.items.properties.urn.type	string
required	properties.alerts.items.required	array of string
type	properties.alerts.items.type	string
type	properties.alerts.type	string
type	properties.analyticsId.type	string
type	properties.batchNotifyPref.type	string
cellular	properties.cellular	object
type	properties.city.type	string
type	properties.consumeLicense.type	string
type	properties.country.type	string
dashboardCharts	properties.dashboardCharts	object
type	properties.dateFormat.type	string
items	properties.delegations.items	string
type	properties.displayName.type	string
type	properties.displayNameExtended.type	string
type	properties.email.type	string
type	properties.enforce2fa.type	string
type	properties.entitlement.type	string
externalAuthReservationToken	properties.externalAuthReservationToken	object
type	properties.externalAuthUserId.type	string
fax	properties.fax	object
type	properties.firstName.type	string
type	properties.groups.items.properties.link.type	string
type	properties.groups.items.properties.longName.type	string
type	properties.groups.items.properties.shortName.type	string
type	properties.groups.items.properties.urn.type	string
required	properties.groups.items.required	array of string
type	properties.groups.items.type	string
type	properties.groups.type	string
type	properties.id.type	string
type	properties.image.properties.large.type	string
type	properties.image.properties.medium.type	string
type	properties.image.properties.small.type	string
type	properties.image.type	string
industry	properties.industry	object
type	properties.interfaceStyle.type	string
type	properties.interfaceStyleMandated.type	string
type	properties.lastAccessTime.type	string
type	properties.lastLicenseTimeIssued.type	string
type	properties.lastLoginTime.type	string
type	properties.lastMowUpdateDate.type	string
type	properties.lastName.type	string
type	properties.lastRecalculateStarted.type	string
type	properties.lastRecalculateUpdate.type	string
type	properties.ldapEnabled.type	string
licenseFeatureId	properties.licenseFeatureId	object
type	properties.licenseType.properties.deleted.type	string
type	properties.licenseType.properties.description.type	string
type	properties.licenseType.properties.link.type	string
type	properties.licenseType.properties.title.type	string
type	properties.licenseType.properties.type.type	string
type	properties.licenseType.properties.urn.type	string
type	properties.licenseType.type	string
type	properties.loginName.type	string
type	properties.mappedToOxygen.type	string
type	properties.organization.type	string
phone	properties.phone	object
type	properties.plmSearchCrawlerUser.type	string
type	properties.postal.type	string
type	properties.preferences.type	string
type	properties.regularUser.type	string
type	properties.reset.type	string
type	properties.showEnableFullAccess.type	string
signupUrl	properties.signupUrl	object
type	properties.stateProv.type	string
type	properties.surveyDone.type	string
type	properties.tenantAdmin.type	string
type	properties.thumbnailPref.type	string
type	properties.timezone.type	string
type	properties.title.type	string
type	properties.twoFaEnabled.type	string
type	properties.twoFactorAuthEnabled.type	string
type	properties.uomPref.type	string
type	properties.urn.type	string
type	properties.userActive.type	string
type	properties.userId.type	string
type	properties.userInactive.type	string
type	properties.userNumber.type	string
type	properties.userStatus.type	string
type	properties.wfNotifyPref.type	string
type	type	string

User list of Permissions

Operation ID:

userPermissionsList

Retrieves a list of all permissions assigned to a specific user.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the user for which to retrieve details.	UserID	True	string	The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.

Returns

Name	Path	Type	Description
type	properties.permissions.items.properties.deleted.type	string
type	properties.permissions.items.properties.link.type	string
type	properties.permissions.items.properties.name.type	string
type	properties.permissions.items.properties.title.type	string
type	properties.permissions.items.properties.urn.type	string
required	properties.permissions.items.required	array of string
type	properties.permissions.items.type	string
type	properties.permissions.type	string
type	type	string

User Outstanding Work

Operation ID:

userOutstandingWork

Retrieves outstanding work for the signed-in user via the API. The @me parameter is used to refer to the currently logged-in user, and it is not possible to choose a different user.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the user to retrieve details.	UserID	True	string	The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.count.type	string
type	properties.lastRecalculateStarted.type	string
type	properties.lastRecalculateUpdate.type	string
type	properties.outstandingWork.items.properties.delegated.type	string
type	properties.outstandingWork.items.properties.escalated.type	string
type	properties.outstandingWork.items.properties.item.properties.deleted.type	string
type	properties.outstandingWork.items.properties.item.properties.link.type	string
type	properties.outstandingWork.items.properties.item.properties.title.type	string
type	properties.outstandingWork.items.properties.item.properties.urn.type	string
type	properties.outstandingWork.items.properties.item.type	string
type	properties.outstandingWork.items.properties.milestoneDate.type	string
type	properties.outstandingWork.items.properties.milestoneStatus.type	string
type	properties.outstandingWork.items.properties.workflowStateName.type	string
type	properties.outstandingWork.items.properties.workflowStateSetDate.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.email.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.image.properties.large.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.image.properties.medium.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.image.properties.small.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.image.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.link.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.status.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.title.type	string
type	properties.outstandingWork.items.properties.workflowUser.properties.urn.type	string
type	properties.outstandingWork.items.properties.workflowUser.type	string
type	properties.outstandingWork.items.properties.workspace.properties.deleted.type	string
type	properties.outstandingWork.items.properties.workspace.properties.link.type	string
type	properties.outstandingWork.items.properties.workspace.properties.title.type	string
type	properties.outstandingWork.items.properties.workspace.properties.type.type	string
type	properties.outstandingWork.items.properties.workspace.properties.urn.type	string
type	properties.outstandingWork.items.properties.workspace.type	string
required	properties.outstandingWork.items.required	array of string
type	properties.outstandingWork.items.type	string
type	properties.outstandingWork.type	string
type	properties.recalculating.type	string
type	type	string

User Permission Detail

Operation ID:

userPermissionDetails

Retrieves the permission details for a specific user within a specific workspace, based on the provided permission ID.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace to retrieve details.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.
Specifies the ID of the user to retrieve details.	UserID	True	string	The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.
Specifies the ID of the permission to retrieve details.	PermissionID	True	integer	The ID of the permission for which you want to retrieve details can be obtained through the GET Permission List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.id.type	string
type	properties.longName.type	string
type	properties.shortName.type	string
type	properties.urn.type	string
type	type	string

User View Details

Operation ID:

userViewDetails

Retrieves detailed information about a specific user’s view.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve details.	ItemID	True	integer	The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.
Specifies the ID of the User View to retrieve details.	ViewID	True	integer	The ID of the User View for which you want to retrieve details can be obtained through the GET User Views based access level API call.
Specifies the field to sort results in ascending order.	asc		string	Specifies the field by which the results should be sorted in ascending order.
Specifies the field to sort results in descending order.	desc		string	Specifies the field by which the results should be sorted in descending order.
Specifies the page number of the results to retrieve.	page		string	Specifies the page number of the results to retrieve. Used for paginating through large datasets.
Specifies the number of items to return per page in a paginated response.	size		string	Specifies the number of items to return per page in a paginated response. This allows clients to control the size of the result set.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.columns.items.properties.displayName.type	string
type	properties.columns.items.properties.id.type	string
type	properties.columns.items.properties.index.type	string
required	properties.columns.items.required	array of string
type	properties.columns.items.type	string
type	properties.columns.type	string
items	properties.items	array of string
type	properties.pageNumber.type	string
type	properties.pageSize.type	string
type	properties.sortingColumns.items.properties.id.type	string
type	properties.sortingColumns.items.properties.index.type	string
type	properties.sortingColumns.items.properties.order.type	string
required	properties.sortingColumns.items.required	array of string
type	properties.sortingColumns.items.type	string
type	properties.sortingColumns.type	string
type	properties.total.type	string
type	properties.urn.type	string
type	type	string

User Views based access level

Operation ID:

userViewsList

Retrieves a list of all user views (user-made filter of items inside a workspace).

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the user views.	WorkspaceID	True	integer	The ID of the workspace containing the user views can be obtained through the GET Workspace List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.links.items.properties.deleted.type	string
type	properties.links.items.properties.link.type	string
type	properties.links.items.properties.title.type	string
type	properties.links.items.properties.urn.type	string
required	properties.links.items.required	array of string
type	properties.links.items.type	string
type	properties.links.type	string
type	type	string

Users In Group

Operation ID:

usersInGroup

Retrieves a list of users and their details for a specific group.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the group for which to retrieve details.	GroupID	True	integer	The ID of the group for which you want to retrieve details can be obtained through the GET Groups List API call.
Specifies the starting index for retrieving items in a paginated result set.	offset		string	Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.__self__.type	string
aboutMe	properties.items.items.properties.aboutMe	object
type	properties.items.items.properties.active.type	string
type	properties.items.items.properties.address1.type	string
type	properties.items.items.properties.address2.type	string
type	properties.items.items.properties.analyticsId.type	string
type	properties.items.items.properties.batchNotifyPref.type	string
type	properties.items.items.properties.cellular.type	string
type	properties.items.items.properties.city.type	string
type	properties.items.items.properties.consumeLicense.type	string
type	properties.items.items.properties.country.type	string
dashboardCharts	properties.items.items.properties.dashboardCharts	object
type	properties.items.items.properties.dateFormat.type	string
delegations	properties.items.items.properties.delegations	array of string
type	properties.items.items.properties.displayName.type	string
type	properties.items.items.properties.displayNameExtended.type	string
type	properties.items.items.properties.email.type	string
type	properties.items.items.properties.enforce2fa.type	string
type	properties.items.items.properties.entitlement.type	string
externalAuthReservationToken	properties.items.items.properties.externalAuthReservationToken	object
type	properties.items.items.properties.externalAuthUserId.type	string
type	properties.items.items.properties.fax.type	string
type	properties.items.items.properties.firstName.type	string
type	properties.items.items.properties.id.type	string
industry	properties.items.items.properties.industry	object
type	properties.items.items.properties.interfaceStyle.type	string
type	properties.items.items.properties.interfaceStyleMandated.type	string
type	properties.items.items.properties.lastAccessTime.type	string
type	properties.items.items.properties.lastLicenseTimeIssued.type	string
type	properties.items.items.properties.lastLoginTime.type	string
type	properties.items.items.properties.lastMowUpdateDate.type	string
type	properties.items.items.properties.lastName.type	string
type	properties.items.items.properties.lastRecalculateStarted.type	string
type	properties.items.items.properties.lastRecalculateUpdate.type	string
type	properties.items.items.properties.ldapEnabled.type	string
type	properties.items.items.properties.licenseFeatureId.type	string
type	properties.items.items.properties.licenseType.properties.deleted.type	string
type	properties.items.items.properties.licenseType.properties.description.type	string
type	properties.items.items.properties.licenseType.properties.link.type	string
type	properties.items.items.properties.licenseType.properties.title.type	string
type	properties.items.items.properties.licenseType.properties.type.type	string
type	properties.items.items.properties.licenseType.properties.urn.type	string
type	properties.items.items.properties.licenseType.type	string
type	properties.items.items.properties.loginName.type	string
type	properties.items.items.properties.mappedToOxygen.type	string
type	properties.items.items.properties.organization.type	string
type	properties.items.items.properties.phone.type	string
type	properties.items.items.properties.plmSearchCrawlerUser.type	string
type	properties.items.items.properties.postal.type	string
type	properties.items.items.properties.regularUser.type	string
type	properties.items.items.properties.reset.type	string
signupUrl	properties.items.items.properties.signupUrl	object
type	properties.items.items.properties.stateProv.type	string
surveyDone	properties.items.items.properties.surveyDone	object
type	properties.items.items.properties.tenantAdmin.type	string
type	properties.items.items.properties.thumbnailPref.type	string
type	properties.items.items.properties.timezone.type	string
type	properties.items.items.properties.title.type	string
type	properties.items.items.properties.twoFactorAuthEnabled.type	string
type	properties.items.items.properties.uomPref.type	string
type	properties.items.items.properties.urn.type	string
type	properties.items.items.properties.userActive.type	string
type	properties.items.items.properties.userId.type	string
type	properties.items.items.properties.userInactive.type	string
type	properties.items.items.properties.userNumber.type	string
type	properties.items.items.properties.userStatus.type	string
type	properties.items.items.properties.wfNotifyPref.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Users List

Operation ID:

usersList

Retrieves a list of all users in the tenant with the option to filter by status.

Parameters

Name	Key	Required	Type	Description
Indicates whether to show only active users.	activeOnly		string	If set to true, shows only users who are currently active.
mappedOnly	mappedOnly		string	If set to true, shows only users who are mappedOnly
Sorts the results alphabetically in ascending or descending order.	sort		string	Sorts the results alphabetically either ascending or descending depending on specified value.

Returns

Name	Path	Type	Description
type	properties.users.items.properties.deleted.type	string
type	properties.users.items.properties.link.type	string
type	properties.users.items.properties.title.type	string
type	properties.users.items.properties.urn.type	string
required	properties.users.items.required	array of string
type	properties.users.items.type	string
type	properties.users.type	string
type	type	string

Workspace Configured View List

Operation ID:

workspaceConfiguredViewList

Retrieves a list of all configured views for a specific workspace.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the configured view.	WorkspaceID	True	integer	The ID of the workspace containing the configured view can be obtained through the GET Workspace List API call.
Specifies the ID of an item inside the workspace.	ItemID	True	integer	The ID of an item inside the workspace, can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	items.properties.deleted.type	string
type	items.properties.link.type	string
type	items.properties.title.type	string
type	items.properties.urn.type	string
required	items.required	array of string
type	items.type	string
type	type	string

Workspace item Tabs List

Operation ID:

workspaceItemTabsList

Retrieves a list of all configured tabs for a specific workspace.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the item.	WorkspaceID	True	integer	The ID of the workspace containing the item can be obtained through the GET Workspace List API call.
Specifies the ID of the item to retrieve the tabs list.	ItemID	True	integer	The ID of the item for which you want to retrieve a tabs list, can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.tabs.items.properties.name.type	string
sectionCounts	properties.tabs.items.properties.sectionCounts	object
type	properties.tabs.items.properties.totalCount.type	string
required	properties.tabs.items.required	array of string
type	properties.tabs.items.type	string
type	properties.tabs.type	string
type	type	string

Workspace Items

Operation ID:

workspaceItemsList

Retrieves a list of all items within a specific workspace.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace containing the items.	WorkspaceID	True	integer	The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.
Specifies the media type expected in the response.	Accept		string	Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk items data in JSON format.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.__self__.type	string
type	properties.items.items.properties.audit.properties.deleted.type	string
type	properties.items.items.properties.audit.properties.link.type	string
type	properties.items.items.properties.audit.type	string
type	properties.items.items.properties.bom.properties.deleted.type	string
type	properties.items.items.properties.bom.properties.link.type	string
type	properties.items.items.properties.bom.type	string
type	properties.items.items.properties.currentState.properties.deleted.type	string
type	properties.items.items.properties.currentState.properties.link.type	string
type	properties.items.items.properties.currentState.properties.title.type	string
type	properties.items.items.properties.currentState.properties.urn.type	string
type	properties.items.items.properties.currentState.type	string
type	properties.items.items.properties.deleted.type	string
type	properties.items.items.properties.flatBom.properties.deleted.type	string
type	properties.items.items.properties.flatBom.properties.link.type	string
type	properties.items.items.properties.flatBom.type	string
type	properties.items.items.properties.itemLocked.type	string
type	properties.items.items.properties.latestRelease.type	string
type	properties.items.items.properties.lifecycle.properties.deleted.type	string
type	properties.items.items.properties.lifecycle.properties.link.type	string
type	properties.items.items.properties.lifecycle.properties.title.type	string
type	properties.items.items.properties.lifecycle.properties.urn.type	string
type	properties.items.items.properties.lifecycle.type	string
type	properties.items.items.properties.milestones.properties.deleted.type	string
type	properties.items.items.properties.milestones.properties.link.type	string
type	properties.items.items.properties.milestones.type	string
type	properties.items.items.properties.nestedBom.properties.count.type	string
type	properties.items.items.properties.nestedBom.properties.deleted.type	string
type	properties.items.items.properties.nestedBom.properties.link.type	string
type	properties.items.items.properties.nestedBom.type	string
type	properties.items.items.properties.owners.properties.deleted.type	string
type	properties.items.items.properties.owners.properties.link.type	string
type	properties.items.items.properties.owners.type	string
type	properties.items.items.properties.root.properties.deleted.type	string
type	properties.items.items.properties.root.properties.link.type	string
type	properties.items.items.properties.root.properties.title.type	string
type	properties.items.items.properties.root.properties.urn.type	string
type	properties.items.items.properties.root.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.title.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.type.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type	string
type	properties.items.items.properties.sections.items.properties.fields.items.properties.value.type	string
required	properties.items.items.properties.sections.items.properties.fields.items.required	array of string
type	properties.items.items.properties.sections.items.properties.fields.items.type	string
type	properties.items.items.properties.sections.items.properties.fields.type	string
type	properties.items.items.properties.sections.items.properties.link.type	string
type	properties.items.items.properties.sections.items.properties.sectionLocked.type	string
type	properties.items.items.properties.sections.items.properties.title.type	string
required	properties.items.items.properties.sections.items.required	array of string
type	properties.items.items.properties.sections.items.type	string
type	properties.items.items.properties.sections.type	string
type	properties.items.items.properties.sectionsLink.type	string
type	properties.items.items.properties.title.type	string
type	properties.items.items.properties.urn.type	string
type	properties.items.items.properties.whereUsed.properties.count.properties.type.type	string
type	properties.items.items.properties.whereUsed.properties.count.properties.value.type	string
type	properties.items.items.properties.whereUsed.properties.count.type	string
type	properties.items.items.properties.whereUsed.properties.link.type	string
type	properties.items.items.properties.whereUsed.type	string
type	properties.items.items.properties.workflowReference.type	string
type	properties.items.items.properties.workingHasChanged.type	string
type	properties.items.items.properties.workingVersion.type	string
type	properties.items.items.properties.workspace.properties.deleted.type	string
type	properties.items.items.properties.workspace.properties.link.type	string
type	properties.items.items.properties.workspace.properties.title.type	string
type	properties.items.items.properties.workspace.properties.type.type	string
type	properties.items.items.properties.workspace.properties.urn.type	string
type	properties.items.items.properties.workspace.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.next.properties.count.type	string
type	properties.next.properties.deleted.type	string
type	properties.next.properties.link.type	string
type	properties.next.properties.title.type	string
type	properties.next.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Workspace List

Operation ID:

workspaceList

Retrieves a list of all workspaces in the tenant.

Parameters

Name	Key	Required	Type	Description
Specifies the maximum number of items to return in the response.	limit		string	Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.

Returns

Name	Path	Type	Description
type	properties.__self__.type	string
type	properties.first.properties.count.type	string
type	properties.first.properties.deleted.type	string
type	properties.first.properties.link.type	string
type	properties.first.properties.title.type	string
type	properties.first.type	string
type	properties.items.items.properties.category.properties.displayOrder.type	string
type	properties.items.items.properties.category.properties.icon.type	string
type	properties.items.items.properties.category.properties.name.type	string
type	properties.items.items.properties.category.type	string
type	properties.items.items.properties.deleted.type	string
type	properties.items.items.properties.displayOrder.type	string
type	properties.items.items.properties.link.type	string
type	properties.items.items.properties.permissions.items.type	string
type	properties.items.items.properties.permissions.type	string
type	properties.items.items.properties.systemName.type	string
type	properties.items.items.properties.title.type	string
type	properties.items.items.properties.urn.type	string
required	properties.items.items.required	array of string
type	properties.items.items.type	string
type	properties.items.type	string
type	properties.last.properties.count.type	string
type	properties.last.properties.deleted.type	string
type	properties.last.properties.link.type	string
type	properties.last.properties.title.type	string
type	properties.last.type	string
type	properties.limit.type	string
type	properties.offset.type	string
type	properties.totalCount.type	string
type	type	string

Workspace List Transitions

Operation ID:

workspaceTransitionslist

Retrieves a list of available transitions for a specific workspace.

Parameters

Name	Key	Required	Type	Description
Specifies the ID of the workspace for retrieving the transition list.	WorkspaceID	True	integer	The ID of the workspace for which you want to retrieve a list of transition can be obtained through the GET Workspace List API call.
Specifies the ID of an item inside the workspace.	ItemID	True	integer	The ID of an item inside the workspace, can be obtained through the GET Item List API call.

Returns

Name	Path	Type	Description
type	items.properties.__self__.type	string
type	items.properties.actionScript.properties.deleted.type	string
type	items.properties.actionScript.properties.link.type	string
type	items.properties.actionScript.properties.title.type	string
type	items.properties.actionScript.properties.urn.type	string
type	items.properties.actionScript.type	string
type	items.properties.approvers.type	string
type	items.properties.comments.type	string
type	items.properties.customLabel.type	string
type	items.properties.delegatorUsers.type	string
type	items.properties.escalationPermission.properties.deleted.type	string
type	items.properties.escalationPermission.properties.link.type	string
type	items.properties.escalationPermission.properties.title.type	string
type	items.properties.escalationPermission.properties.urn.type	string
type	items.properties.escalationPermission.type	string
type	items.properties.fromState.properties.deleted.type	string
type	items.properties.fromState.properties.link.type	string
type	items.properties.fromState.properties.title.type	string
type	items.properties.fromState.properties.urn.type	string
type	items.properties.fromState.type	string
type	items.properties.hidden.type	string
type	items.properties.ignoreEscalatedPreconditions.type	string
type	items.properties.labelPositionA.type	string
type	items.properties.labelPositionB.type	string
type	items.properties.name.type	string
type	items.properties.notifyPerformers.type	string
type	items.properties.passwordEnabled.type	string
type	items.properties.permission.properties.deleted.type	string
type	items.properties.permission.properties.link.type	string
type	items.properties.permission.properties.title.type	string
type	items.properties.permission.properties.urn.type	string
type	items.properties.permission.type	string
points	items.properties.points	object
type	items.properties.sendEmail.type	string
type	items.properties.showInOutstanding.type	string
type	items.properties.toState.properties.deleted.type	string
type	items.properties.toState.properties.link.type	string
type	items.properties.toState.properties.title.type	string
type	items.properties.toState.properties.urn.type	string
type	items.properties.toState.type	string
type	items.properties.urn.type	string
type	items.properties.workspace.properties.deleted.type	string
type	items.properties.workspace.properties.link.type	string
type	items.properties.workspace.properties.title.type	string
type	items.properties.workspace.properties.type.type	string
type	items.properties.workspace.properties.urn.type	string
type	items.properties.workspace.type	string
required	items.required	array of string
type	items.type	string
type	type	string

Definitions

200_sections

Name	Path	Type	Description
name	name	string
description	description	string
type	type	string
displayOrder	displayOrder	integer
sectionType	sectionType	string
fields	fields	array of object
link	fields.link	string
urn	fields.urn	string
title	fields.title	string
deleted	fields.deleted	boolean
type	fields.type	string
sectionLocked	sectionLocked	boolean
pimSection	pimSection	boolean
__self__	__self__	string
urn	urn	string
matrices	matrices	array of object
__self__	matrices.__self__	string
urn	matrices.urn	string
width	matrices.width	integer
height	matrices.height	integer
columnNames	matrices.columnNames	array of string
rowNames	matrices.rowNames	array of string
fields	matrices.fields	array of array
items	matrices.fields	array of object
link	matrices.fields.link	string
urn	matrices.fields.urn	string
title	matrices.fields.title	string
deleted	matrices.fields.deleted	boolean
type	matrices.fields.type	string

ApiV3Workspaces-WorkspaceID-Items-ItemID-Views10Get200ApplicationJsonResponse

Name	Path	Type	Description
Items		string