Trisotech Digital Enterprise Suite API
- 1. Access
- 2. Endpoints
- 2.1. Assets
- 2.1.1. GET /assets/{environment}
- 2.1.2. GET /assets/{environment}/{group}/{artifact}
- 2.1.3. DELETE /assets/{environment}/{group}/{artifact}/{name}
- 2.1.4. GET /assets/{environment}/{group}/{artifact}/{name}
- 2.1.5. POST /assets/{environment}/{group}/{artifact}/{name}
- 2.1.6. GET /assets/{environment}/{group}
- 2.1.7. DELETE /assets/{environment}/{group}/{name}
- 2.1.8. GET /assets/{environment}/{group}/{name}
- 2.1.9. POST /assets/{environment}/{group}/{name}
- 2.1.10. DELETE /assets/{environment}/{name}
- 2.1.11. GET /assets/{environment}/{name}
- 2.1.12. POST /assets/{environment}/{name}
- 2.1.13. GET /assets
- 2.1.14. DELETE /assets/{name}
- 2.1.15. GET /assets/{name}
- 2.1.16. POST /assets/{name}
- 2.2. ContainerDeployment
- 2.3. DataStores
- 2.3.1. DELETE /datastore/contents/{id}
- 2.3.2. GET /datastore/contents/{id}
- 2.3.3. POST /datastore/contents/{id}
- 2.3.4. GET /datastore/definitions
- 2.3.5. DELETE /datastore/definitions/{id}
- 2.3.6. GET /datastore/definitions/{id}
- 2.3.7. PUT /datastore/definitions/{id}
- 2.3.8. POST /datastore/definitions
- 2.4. Deployments
- 2.4.1. DELETE /deployments/bpmn/{environment}/{groupId}/{artifactId}/{version}
- 2.4.2. POST /deployments/bpmn/{environment}/{groupId}/{artifactId}/{version}
- 2.4.3. DELETE /deployments/cmmn/{environment}/{groupId}/{artifactId}/{version}
- 2.4.4. POST /deployments/cmmn/{environment}/{groupId}/{artifactId}/{version}
- 2.4.5. DELETE /deployments/dmn/{environment}/{groupId}/{artifactId}/{version}
- 2.4.6. POST /deployments/dmn/{environment}/{groupId}/{artifactId}/{version}
- 2.5. Event
- 2.6. EventEmitters
- 2.6.1. GET /emitters/audit/{id}
- 2.6.2. GET /emitters/definitions
- 2.6.3. DELETE /emitters/definitions/{id}
- 2.6.4. POST /emitters/definitions/{id}/disable
- 2.6.5. POST /emitters/definitions/{id}/enable
- 2.6.6. GET /emitters/definitions/{id}
- 2.6.7. PUT /emitters/definitions/{id}
- 2.6.8. POST /emitters/definitions
- 2.6.9. GET /emitters
- 2.7. ExecutionEnvironmentArtifacts
- 2.8. ExecutionEnvironmentFile
- 2.9. ExecutionEnvironments
- 2.10. GroupAndMembers
- 2.11. Identities
- 2.12. Issue
- 2.13. IssueComment
- 2.14. Login
- 2.15. Mimetype
- 2.16. PlaceContent
- 2.17. PlaceContentLink
- 2.18. PlaceContentPromotion
- 2.19. PlaceContentRecovery
- 2.20. PlaceContentSearch
- 2.21. PlaceContentVersion
- 2.22. Places
- 2.23. RequestAccess
- 2.24. ServiceMigration
- 2.25. TestData
- 2.26. UserTasksSearch
- 2.27. Users
- 2.1. Assets
- 3. Models
- 3.1. AccessRequest
- 3.2. Asset
- 3.3. AssetsGet200Response
- 3.4. CommentEvent
- 3.5. CommentEventAllOf
- 3.6. ContainerBuilt
- 3.7. ContainerMultiplePostRequest
- 3.8. ContainerMultiplePostRequestServicesInner
- 3.9. ContainerSinglePostRequest
- 3.10. DataStore
- 3.11. DatastoreContentsIdGet200Response
- 3.12. DatastoreContentsIdPost200Response
- 3.13. DeploymentsBpmnEnvironmentGroupIdArtifactIdVersionPostRequest
- 3.14. EmitterDef
- 3.15. EmitterParameter
- 3.16. EmitterType
- 3.17. EmittersDefinitionsGet200Response
- 3.18. EmittersDefinitionsIdGet200Response
- 3.19. EmittersGet200Response
- 3.20. ErrorMessage
- 3.21. ErrorMessageErrorInner
- 3.22. Event
- 3.23. EventDef
- 3.24. ExecutionRepository
- 3.25. ExecutionrepositoryDelete200Response
- 3.26. ExecutionrepositoryGet200Response
- 3.27. ExecutionrepositoryartifactGet200Response
- 3.28. ExecutionrepositoryartifactPost200Response
- 3.29. File
- 3.30. FileOrFolder
- 3.31. FileOrFolderFile
- 3.32. FileOrFolderFolder
- 3.33. GAV
- 3.34. GroupDef
- 3.35. GroupsGet200Response
- 3.36. GroupsPost200Response
- 3.37. Identity
- 3.38. IdentityDelete200Response
- 3.39. IdentityGet200Response
- 3.40. Issue
- 3.41. IssueGet200Response
- 3.42. IssuePut200Response
- 3.43. IssuecommentGet200Response
- 3.44. IssuecommentPut200Response
- 3.45. LogEntry
- 3.46. LoginDelete200Response
- 3.47. LoginGet200Response
- 3.48. LoginGet200ResponseData
- 3.49. Member
- 3.50. MimetypeGet200Response
- 3.51. MimetypeGet200ResponseDataInner
- 3.52. Repository
- 3.53. RepositoryGet200Response
- 3.54. RepositoryMember
- 3.55. RepositoryPut200Response
- 3.56. RepositoryRights
- 3.57. RepositorycontentGet200Response
- 3.58. RepositoryfilerecoveryPost200Response
- 3.59. RepositoryfileversionGet200Response
- 3.60. RepositorymemberGet200Response
- 3.61. RepositorymemberPut200Response
- 3.62. RepositorypromotePost200Response
- 3.63. RepositorypromotePost200ResponseData
- 3.64. RequestaccessGet200Response
- 3.65. ServiceDescriptor
- 3.66. ServiceInstanceMigrationStatus
- 3.67. ServiceMigrationContext
- 3.68. ServiceMigrationContextProcessNodesValueInner
- 3.69. ServiceMigrationReport
- 3.70. TestdataGet200Response
- 3.71. TestdataTypeGet200Response
- 3.72. User
- 3.73. UserEvent
- 3.74. UserEventAllOf
- 3.75. UserGet200Response
- 3.76. UserTasksInner
- 3.77. ValidationIssue
The Trisotech Public API let you access various Digital Enterprise Suite resources through a convenient HTTP REST API.
1. Access
-
OAuth AuthorizationUrl: https://[instance].trisotech.com/oauth2/auth, TokenUrl: https://[instance].trisotech.com/oauth2/token
2. Endpoints
2.1. Assets
2.1.1. GET /assets/{environment}
- Operation Id
-
assetsEnvironmentGet
List assets for specified mime type at environment level
2.1.2. GET /assets/{environment}/{group}/{artifact}
- Operation Id
-
assetsEnvironmentGroupArtifactGet
List assets for specified mime type at artifact level
Parameters
2.1.3. DELETE /assets/{environment}/{group}/{artifact}/{name}
- Operation Id
-
assetsEnvironmentGroupArtifactNameDelete
Delete asset
2.1.4. GET /assets/{environment}/{group}/{artifact}/{name}
- Operation Id
-
assetsEnvironmentGroupArtifactNameGet
Asset content
2.1.5. POST /assets/{environment}/{group}/{artifact}/{name}
- Operation Id
-
assetsEnvironmentGroupArtifactNamePost
Content to create an asset
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
Environment. |
X |
null |
|
group |
Group. |
X |
null |
|
artifact |
Artifact. |
X |
null |
|
name |
Name of asset. |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
file |
The asset to store. [file] |
- |
null |
2.1.6. GET /assets/{environment}/{group}
- Operation Id
-
assetsEnvironmentGroupGet
List assets for specified mime type at group level
Parameters
2.1.7. DELETE /assets/{environment}/{group}/{name}
- Operation Id
-
assetsEnvironmentGroupNameDelete
Delete asset
2.1.8. GET /assets/{environment}/{group}/{name}
- Operation Id
-
assetsEnvironmentGroupNameGet
Asset content
2.1.9. POST /assets/{environment}/{group}/{name}
- Operation Id
-
assetsEnvironmentGroupNamePost
Content to create an asset
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
Environment. |
X |
null |
|
group |
Group. |
X |
null |
|
name |
Name of asset. |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
file |
The asset to store. [file] |
- |
null |
2.1.10. DELETE /assets/{environment}/{name}
- Operation Id
-
assetsEnvironmentNameDelete
Delete asset
2.1.11. GET /assets/{environment}/{name}
- Operation Id
-
assetsEnvironmentNameGet
Asset content
2.1.12. POST /assets/{environment}/{name}
- Operation Id
-
assetsEnvironmentNamePost
Content to create an asset
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
Environment. |
X |
null |
|
name |
Name of asset. |
X |
null |
2.1.13. GET /assets
- Operation Id
-
assetsGet
List assets for specified mime type
2.1.14. DELETE /assets/{name}
- Operation Id
-
assetsNameDelete
Asset content
2.1.15. GET /assets/{name}
- Operation Id
-
assetsNameGet
Asset content
2.2. ContainerDeployment
2.2.1. POST /container/multiple
- Operation Id
-
containerMultiplePost
Push a container of multiple services to an extenral repository.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ContainerMultiplePostRequest |
The services to deploy. ContainerMultiplePostRequest |
X |
2.2.2. POST /container/single
- Operation Id
-
containerSinglePost
Push a service container to an extenral repository.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ContainerSinglePostRequest |
The services to deploy. ContainerSinglePostRequest |
X |
2.3. DataStores
2.3.1. DELETE /datastore/contents/{id}
- Operation Id
-
datastoreContentsIdDelete
Delete data store content associated with id.
2.3.2. GET /datastore/contents/{id}
- Operation Id
-
datastoreContentsIdGet
Retrieve data stores content associated with requesting id.
Content Type
-
application/json
-
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml
2.3.3. POST /datastore/contents/{id}
- Operation Id
-
datastoreContentsIdPost
Add content to data store associated with requesting id.
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
name |
The data store name. Shouldn't be provided with an id. |
- |
null |
|
replace |
Determines if the content from the import should replace or append data (defaults to false). |
- |
null |
|
datatypeName |
The data store data type name. |
- |
null |
|
itemDatatypeName |
The data store item data type name. |
- |
null |
2.3.4. GET /datastore/definitions
- Operation Id
-
datastoreDefinitionsGet
Retrieve data stores associated with requesting user.
2.3.5. DELETE /datastore/definitions/{id}
- Operation Id
-
datastoreDefinitionsIdDelete
Delete data store associated with id.
2.3.6. GET /datastore/definitions/{id}
- Operation Id
-
datastoreDefinitionsIdGet
Retrieve data stores associated with id.
2.3.7. PUT /datastore/definitions/{id}
- Operation Id
-
datastoreDefinitionsIdPut
Update data store associated with id (name, owner).
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The new data store definition. DataStore |
- |
2.3.8. POST /datastore/definitions
- Operation Id
-
datastoreDefinitionsPost
Creates new data store definition.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The new data store definition. DataStore |
X |
2.4. Deployments
2.4.1. DELETE /deployments/bpmn/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
deploymentsBpmnEnvironmentGroupIdArtifactIdVersionDelete
Delete service that was previously deployed with given id (group, artifact, version) within the environment.
Return Type
array[LogEntry]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Service has been successfully undeployed. |
List[LogEntry] |
500 |
An error occurred. |
2.4.2. POST /deployments/bpmn/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
deploymentsBpmnEnvironmentGroupIdArtifactIdVersionPost
Deploys process model(s) as service.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
The environment where service should be deployed to. |
X |
null |
|
groupId |
The group of the service. |
X |
null |
|
artifactId |
The artifact of the service. |
X |
null |
|
version |
The version of the service. |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
model |
The file to upload. [file] |
- |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
profile |
The execution profile to be used. |
- |
null |
|
repositoryId |
The identifier of the repository where service model should be fetched from. |
- |
null |
|
modelId |
Model identifier to be used as main model of the service. |
- |
null |
|
identities |
The identitifer of the identity to be added to the service during deployment. [String] |
- |
null |
|
typeValidationMode |
The data type validation mode to be used. |
- |
null |
Return Type
array[LogEntry]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Log details of the deployment operation. |
List[LogEntry] |
500 |
An error occurred. |
2.4.3. DELETE /deployments/cmmn/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
deploymentsCmmnEnvironmentGroupIdArtifactIdVersionDelete
Delete service that was previously deployed with given id (group, artifact, version) within the environment.
Return Type
array[LogEntry]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Service has been successfully undeployed. |
List[LogEntry] |
500 |
An error occurred. |
2.4.4. POST /deployments/cmmn/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
deploymentsCmmnEnvironmentGroupIdArtifactIdVersionPost
Deploys case model(s) as service.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
The environment where service should be deployed to. |
X |
null |
|
groupId |
The group of the service. |
X |
null |
|
artifactId |
The artifact of the service. |
X |
null |
|
version |
The version of the service. |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
model |
The file to upload. [file] |
- |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
profile |
The execution profile to be used. |
- |
null |
|
repositoryId |
The identifier of the repository where service model should be fetched from. |
- |
null |
|
modelId |
Model identifier to be used as main model of the service. |
- |
null |
|
identities |
The identitifer of the identity to be added to the service during deployment. [String] |
- |
null |
|
typeValidationMode |
The data type validation mode to be used. |
- |
null |
Return Type
array[LogEntry]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Log details of the deployment operation. |
List[LogEntry] |
500 |
An error occurred. |
2.4.5. DELETE /deployments/dmn/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
deploymentsDmnEnvironmentGroupIdArtifactIdVersionDelete
Delete service that was previously deployed with given id (group, artifact, version) within the environment.
Return Type
array[LogEntry]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Service has been successfully undeployed. |
List[LogEntry] |
500 |
An error occurred. |
2.4.6. POST /deployments/dmn/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
deploymentsDmnEnvironmentGroupIdArtifactIdVersionPost
Deploys decision model(s) as service.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
The environment where service should be deployed to. |
X |
null |
|
groupId |
The group of the service. |
X |
null |
|
artifactId |
The artifact of the service. |
X |
null |
|
version |
The version of the service. |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
model |
The file to upload. [file] |
- |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
profile |
The execution profile to be used. |
- |
null |
|
repositoryId |
The identifier of the repository where service model should be fetched from. |
- |
null |
|
modelId |
Model identifier to be used as main model of the service. |
- |
null |
|
identities |
The identitifer of the identity to be added to the service during deployment. [String] |
- |
null |
|
typeValidationMode |
The data type validation mode to be used. |
- |
null |
Return Type
array[LogEntry]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Log details of the deployment operation. |
List[LogEntry] |
500 |
An error occurred. |
2.5. Event
2.5.1. POST /event
- Operation Id
-
eventPost
Publish a message
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
message |
Description of the event. EventDef |
X |
2.6. EventEmitters
2.6.1. GET /emitters/audit/{id}
- Operation Id
-
emittersAuditIdGet
Download audit logs.
2.6.2. GET /emitters/definitions
- Operation Id
-
emittersDefinitionsGet
Retrieve event emitter definitions for requesting user.
2.6.3. DELETE /emitters/definitions/{id}
- Operation Id
-
emittersDefinitionsIdDelete
Delete an event emitter definition.
2.6.4. POST /emitters/definitions/{id}/disable
- Operation Id
-
emittersDefinitionsIdDisablePost
Disable event emitter definition for given id.
2.6.5. POST /emitters/definitions/{id}/enable
- Operation Id
-
emittersDefinitionsIdEnablePost
Enable event emitter definition for given id.
2.6.6. GET /emitters/definitions/{id}
- Operation Id
-
emittersDefinitionsIdGet
Retrieve event emitter definition for given id.
2.6.7. PUT /emitters/definitions/{id}
- Operation Id
-
emittersDefinitionsIdPut
Updates existing event emitter definition.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The event emitter definition id. |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The updated event emitter definition. EmitterDef |
X |
2.6.8. POST /emitters/definitions
- Operation Id
-
emittersDefinitionsPost
Creates new event emitter definition.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The new event emitter definition. EmitterDef |
X |
2.7. ExecutionEnvironmentArtifacts
2.7.1. DELETE /executionrepositoryartifact
- Operation Id
-
executionrepositoryartifactDelete
Delete an artifact in an execution environment. If a version is provided, this specific artifact version will be deleted instead of all versions.
2.7.2. GET /executionrepositoryartifact
- Operation Id
-
executionrepositoryartifactGet
List the latest version of artifacts inside an execution environment.
2.8. ExecutionEnvironmentFile
2.9. ExecutionEnvironments
2.9.1. DELETE /executionrepository
- Operation Id
-
executionrepositoryDelete
Delete an Execution Environment
2.9.2. GET /executionrepository
- Operation Id
-
executionrepositoryGet
List all the execution environments that you have access to.
2.9.3. POST /executionrepository
- Operation Id
-
executionrepositoryPost
Create a new Execution Environment
2.10. GroupAndMembers
2.10.1. GET /groups
- Operation Id
-
groupsGet
Retrieve all groups.
2.10.2. DELETE /groups/{groupId}
- Operation Id
-
groupsGroupIdDelete
Delete a Group.
2.10.3. GET /groups/{groupId}
- Operation Id
-
groupsGroupIdGet
Retrieves selected group by its id.
2.10.4. DELETE /groups/{groupId}/members
- Operation Id
-
groupsGroupIdMembersDelete
Delete a Group member.
2.10.5. GET /groups/{groupId}/members
- Operation Id
-
groupsGroupIdMembersGet
Retrieves selected group members.
2.10.6. PUT /groups/{groupId}/members
- Operation Id
-
groupsGroupIdMembersPut
Add a member(s) to the group.
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
user |
The user id to be added as group member. |
- |
null |
|
group |
The group id to be added as group member. |
- |
null |
|
subject |
The invitation email subject. |
- |
null |
|
message |
The invitation email message. |
- |
null |
|
sendEmail |
Wether to send or not an invigation email. |
X |
null |
2.10.7. PUT /groups/{groupId}
- Operation Id
-
groupsGroupIdPut
Update a Group name.
2.11. Identities
2.11.1. DELETE /identity
- Operation Id
-
identityDelete
Delete an identity.
2.11.2. GET /identity
- Operation Id
-
identityGet
Retrieve identities associated with requesting user.
2.11.3. DELETE /identity/{id}
- Operation Id
-
identityIdDelete
Delete an identity.
2.11.4. GET /identity/{id}
- Operation Id
-
identityIdGet
Retrieve identity with the given id.
2.11.5. PUT /identity/{id}
- Operation Id
-
identityIdPut
Modify identity attributes.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
identity |
The identity new values. Identity |
X |
2.12. Issue
2.12.1. DELETE /issue
- Operation Id
-
issueDelete
Delete Issue in of a repository.
2.12.2. GET /issue
- Operation Id
-
issueGet
Retrieve issues.
2.12.3. POST /issue
- Operation Id
-
issuePost
Create a new Issue.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The new issue. Issue |
X |
2.12.4. PUT /issue
- Operation Id
-
issuePut
Update Issue in of a repository.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The updated issue. Issue |
X |
2.13. IssueComment
2.13.2. GET /issuecomment
- Operation Id
-
issuecommentGet
Retrieve all CommentEvents of a issue.
2.13.3. POST /issuecomment
- Operation Id
-
issuecommentPost
Create a new CommentEvent.
Description
When creating a new CommentEvent. You can define the guid of the new comment or not (null).
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The new CommentEvent. CommentEvent |
X |
2.13.4. PUT /issuecomment
- Operation Id
-
issuecommentPut
Update a CommentEvent of a Issue.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The updated CommentEvent. CommentEvent |
X |
2.14. Login
2.14.1. DELETE /login
- Operation Id
-
loginDelete
Logout the current user from the API. Will not have any effect if called with a Bearer Token authentication (OAUTH).
2.15. Mimetype
2.16. PlaceContent
2.16.1. DELETE /repositorycontent
- Operation Id
-
repositorycontentDelete
Delete a file or folder in a place
2.16.2. GET /repositorycontent
- Operation Id
-
repositorycontentGet
Information on the content in a place
2.16.3. GET /repositorycontent/package
- Operation Id
-
repositorycontentPackageGet
Packages model and its imported models as zip archive.
2.16.4. POST /repositorycontent
- Operation Id
-
repositorycontentPost
Create a new file or folder in the place
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
repository |
The place id (or deprecated sku). |
X |
null |
|
path |
The path to store the new file (if a file is provided) or the path to create. |
- |
null |
|
name |
The filename to use (when creating a file only). |
- |
null |
|
mimetype |
File mime type (when creating a file only). |
- |
null |
|
version |
The file numeric file version of this model None if ommited. |
- |
null |
|
state |
The publication state of the file. None if ommited |
- |
null |
2.17. PlaceContentLink
2.17.1. GET /repositorylink
- Operation Id
-
repositorylinkGet
Generate a direct URL to access a place content (visualize or edit)
Description
You can obtain different type of links: view the model (viewer), present the model in a portal (portal), edit the model (editor). Note that the user requesting the link needs to have access to the model to generate the link. The link is not tied to a user and could be also used by another user with the proper access rights to the model.
2.18. PlaceContentPromotion
2.18.1. POST /repositorypromote
- Operation Id
-
repositorypromotePost
Copy the content of the source place to the target place removing any models in the target place not in the source place. Optionnaly, this method can set a state and/or a version on the target place content.
2.19. PlaceContentRecovery
2.19.1. GET /repositoryfilerecovery
- Operation Id
-
repositoryfilerecoveryGet
List all deleted files in a place (across all paths).
2.20. PlaceContentSearch
2.20.1. GET /repositorysearch
- Operation Id
-
repositorysearchGet
Search a place (or all places) for a file or folder matching the search query
Description
The search is case insensitive and will match on folders or model files matching the optional mimetypes.
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
search |
The required search term that will be matched ignoring cases with model names. |
X |
null |
|
repository |
The optional place id. Not providing a place search in all places that the user has access to. |
- |
null |
|
path |
Optional path where the search should start at. |
- |
null |
|
mimetype |
Optional mimetype to get a different mimetype than the default mimetype of the content. |
- |
null |
2.21. PlaceContentVersion
2.22. Places
2.22.1. DELETE /repository
- Operation Id
-
repositoryDelete
Delete a Place
2.22.2. GET /repository
- Operation Id
-
repositoryGet
List all the places that you have access to.
2.22.3. POST /repository
- Operation Id
-
repositoryPost
Create a new Place
2.22.4. PUT /repository
- Operation Id
-
repositoryPut
Rename a Place or set its production rights
2.22.5. DELETE /repositorymember
- Operation Id
-
repositorymemberDelete
Uninvite a Place member
2.22.6. GET /repositorymember
- Operation Id
-
repositorymemberGet
List all the places members.
2.22.7. POST /repositorymember
- Operation Id
-
repositorymemberPost
Invite a member (user or group) to a Place
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The Place identifier. |
X |
null |
|
Emails of the person that you wish to invite. |
- |
null |
||
group |
ID of the group that you wish to invite. |
- |
null |
|
subject |
The invitation email subject. |
- |
null |
|
message |
The invitation email message. |
- |
null |
|
sendEmail |
Wether to send or not an invigation email. |
X |
null |
|
name |
Name of the person that you wish to invite. |
- |
null |
2.22.8. PUT /repositorymember
- Operation Id
-
repositorymemberPut
Change a member rights to the Place.
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
id |
The Place identifier. |
X |
null |
|
The new email of the person to change the rights for. |
X |
null |
||
group |
ID of the group to change the rights for. |
- |
null |
|
rights |
The global access rule to set on this place. |
- |
null |
|
owner |
true if the member is the owner of the place, false otherwize. |
- |
null |
|
write |
true if the member can write to the place, false if he can only read. |
- |
null |
2.23. RequestAccess
2.23.1. DELETE /requestaccess
- Operation Id
-
requestaccessDelete
Delete the access request with the corresponding email specified in the parameter. (Admin rights required)
2.24. ServiceMigration
2.24.1. POST /migration/services/{environment}/{groupId}/{artifactId}/{version}
- Operation Id
-
migrationServicesEnvironmentGroupIdArtifactIdVersionPost
Migrates service instances to another version.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
environment |
The environment of the source service. |
X |
null |
|
groupId |
The group of the source service. |
X |
null |
|
artifactId |
The artifact of the source service. |
X |
null |
|
version |
The version of the source service. |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
targetVersion |
The target version of the service where instances should be migrated to. |
X |
null |
|
tag |
Filter service instances by associated tag, when multiple given all must match [String] |
- |
null |
|
filter |
Filter service instances by name or id |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Report from service instance migration. |
|
400 |
Invalid or missing information required for migration. |
List[ValidationIssue] |
500 |
An error occurred. |
2.25. TestData
2.25.1. GET /testdata
- Operation Id
-
testdataGet
Retrieve defined data types for test data
2.25.2. DELETE /testdata/{type}
- Operation Id
-
testdataTypeDelete
Delete existing data type including test data files.
2.25.3. GET /testdata/{type}
- Operation Id
-
testdataTypeGet
Retrieve test data file names for given type
2.25.4. DELETE /testdata/{type}/{name}
- Operation Id
-
testdataTypeNameDelete
Delete test data file given by name that belongs to given type.
2.25.5. GET /testdata/{type}/{name}
- Operation Id
-
testdataTypeNameGet
Retrieve test data file with given name for given type (uses accept header to determine data format).
2.25.6. POST /testdata/{type}/{name}
- Operation Id
-
testdataTypeNamePost
Create or update test data file with given name and for given type.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
type |
The name of the data type. |
X |
null |
|
name |
The name of the test data file. |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The content of the test data file. [object] |
- |
2.26. UserTasksSearch
2.26.1. GET /tasks
- Operation Id
-
searchUserTasks3
Searches for user tasks across all environments and services
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Page number to get (defaults to first) |
- |
null |
|
pageSize |
Number of user tasks to retrieve (defaults to 10) |
- |
null |
|
sortBy |
Sort user tasks by predefined field |
- |
null |
|
sortOrder |
Sort user tasks by predefined field either ascending (default) or descending |
- |
null |
|
filterBy |
Filter user tasks by predefined field |
- |
null |
|
filter |
Filter user tasks by name or id, or instance name |
- |
null |
|
tag |
Filter user tasks by instance tags [String] |
- |
null |
Return Type
array[[UserTasks_inner]]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User tasks |
List[[UserTasks_inner]] |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
2.26.2. GET /tasks/{env}
- Operation Id
-
searchUserTasks4
Searches for user tasks across all services in selected environment
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
env |
The environment where services are deployed |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Page number to get (defaults to first) |
- |
null |
|
pageSize |
Number of user tasks to retrieve (defaults to 10) |
- |
null |
|
sortBy |
Sort user tasks by predefined field |
- |
null |
|
sortOrder |
Sort user tasks by predefined field either ascending (default) or descending |
- |
null |
|
filterBy |
Filter user tasks by predefined field |
- |
null |
|
filter |
Filter user tasks by name or id, or instance name |
- |
null |
|
tag |
Filter user tasks by instance tags [String] |
- |
null |
Return Type
array[[UserTasks_inner]]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User tasks |
List[[UserTasks_inner]] |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
2.26.3. GET /tasks/{env}/{group}
- Operation Id
-
searchUserTasks5
Searches for user tasks across all services in selected environment and group
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
env |
The environment where services are deployed |
X |
null |
|
group |
The group of the service |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Page number to get (defaults to first) |
- |
null |
|
pageSize |
Number of user tasks to retrieve (defaults to 10) |
- |
null |
|
sortBy |
Sort user tasks by predefined field |
- |
null |
|
sortOrder |
Sort user tasks by predefined field either ascending (default) or descending |
- |
null |
|
filterBy |
Filter user tasks by predefined field |
- |
null |
|
filter |
Filter user tasks by name or id, or instance name |
- |
null |
|
tag |
Filter user tasks by instance tags [String] |
- |
null |
Return Type
array[[UserTasks_inner]]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User tasks |
List[[UserTasks_inner]] |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
2.26.4. GET /tasks/{env}/{group}/{artifact}
- Operation Id
-
searchUserTasks6
Searches for user tasks across all versions of a selected service in selected group and environment
Description
Searches for user tasks across all versions of a selected service in selected group and environment
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
env |
The environment where services are deployed |
X |
null |
|
group |
The group of the service |
X |
null |
|
artifact |
The artifact of the service |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Page number to get (defaults to first) |
- |
null |
|
pageSize |
Number of user tasks to retrieve (defaults to 10) |
- |
null |
|
sortBy |
Sort user tasks by predefined field |
- |
null |
|
sortOrder |
Sort user tasks by predefined field either ascending (default) or descending |
- |
null |
|
filterBy |
Filter user tasks by predefined field |
- |
null |
|
filter |
Filter user tasks by name or id, or instance name |
- |
null |
|
tag |
Filter user tasks by instance tags [String] |
- |
null |
Return Type
array[[UserTasks_inner]]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User tasks |
List[[UserTasks_inner]] |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
2.26.5. GET /tasks/{env}/{group}/{artifact}/{version}
- Operation Id
-
searchUserTasks7
Searches for user tasks from selected version of selected service in selected group and environment
Description
Searches for user tasks from selected version of selected service in selected group and environment
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
env |
The environment where services are deployed |
X |
null |
|
group |
The group of the service |
X |
null |
|
artifact |
The artifact of the service |
X |
null |
|
version |
The version of the service |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
page |
Page number to get (defaults to first) |
- |
null |
|
pageSize |
Number of user tasks to retrieve (defaults to 10) |
- |
null |
|
sortBy |
Sort user tasks by predefined field |
- |
null |
|
sortOrder |
Sort user tasks by predefined field either ascending (default) or descending |
- |
null |
|
filterBy |
Filter user tasks by predefined field |
- |
null |
|
filter |
Filter user tasks by name or id, or instance name |
- |
null |
|
tag |
Filter user tasks by instance tags [String] |
- |
null |
Return Type
array[[UserTasks_inner]]
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User tasks |
List[[UserTasks_inner]] |
401 |
Unauthorized |
<<>> |
500 |
Internal server error |
2.27. Users
2.27.1. DELETE /user
- Operation Id
-
userDelete
Deleted users. (Admin rights required)
2.27.2. GET /user
- Operation Id
-
userGet
List all users with a valid license on the server.
2.27.3. POST /user
- Operation Id
-
userPost
Add users on the server and send invitations to them. (Admin rights required)
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
List of user email(s) (comma separated) that you want to invite |
X |
null |
||
read |
List of the repositories id(s) (comma separated) with read rights for invited users |
- |
null |
|
write |
List of the repositories id(s) (comma separated) with write rights for invited users |
- |
null |
|
subject |
Invitation email subject (if either subject or message are missing, no email will be sent) |
- |
null |
|
message |
Invitation email message (if either subject or message are missing, no email will be sent) |
- |
null |
3. Models
3.1. AccessRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
created |
String |
The creation date of the request. |
||
String |
The user email address. |
3.2. Asset
Describe an asset object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
path |
String |
Asset path |
||
type |
String |
Asset type |
||
name |
String |
Asset name |
3.3. AssetsGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of Asset |
All assets available. |
3.4. CommentEvent
Describe an CommentEvent.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
guid |
String |
The guid of the CommentEvent. When updating a comment, this field only use to determine which comment to update. |
||
memberEmail |
String |
The email of the member that create the event. When updating or creating a comment, this field is ignore. |
||
memberDisplayName |
String |
The name of the member that create the event. When updating or creating a comment, this field is ignore. |
||
memberImage |
String |
The image of the member that create the event. When updating or creating a comment, this field is ignore. |
||
date |
date |
The date of the event. When updating or creating a comment, this field is ignore. |
date |
|
operationType |
String |
The type of the event. When updating or creating a comment, this field is ignore. |
Enum: CREATE, RESOLVE, UPDATE, COMMENT, |
|
message |
String |
The message of the comment. |
||
replyTo |
String |
The guid of the comment that this comment reply to. |
3.5. CommentEventAllOf
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
message |
String |
The message of the comment. |
||
replyTo |
String |
The guid of the comment that this comment reply to. |
3.6. ContainerBuilt
Describe a emitter type object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
image |
String |
The name of the emitter. |
||
descriptors |
Map of [array] |
List of service descriptors keyed by service id (repository, group, artifact, version). |
3.7. ContainerMultiplePostRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
image |
String |
The registry image to publish to. |
||
username |
String |
The optional username for contaier registry |
||
password |
String |
The optional password for the container registry |
||
identity |
String |
The optional identity identifier containing the credentials to use as username and password. |
||
environment |
String |
The source environment for the services |
||
services |
3.8. ContainerMultiplePostRequestServicesInner
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
group |
String |
The group of the service. |
||
artifact |
String |
The artifact of the service. |
||
version |
String |
The version of the service. A value of null means the latest, a value of '*' means all versions. |
3.9. ContainerSinglePostRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
image |
String |
The registry image to publish to. |
||
username |
String |
The optional username for contaier registry |
||
password |
String |
The optional password for the container registry |
||
identity |
String |
The optional identity identifier containing the credentials to use as username and password. |
||
environment |
String |
The source environment for the services |
||
group |
String |
The group of the service. |
||
artifact |
String |
The artifact of the service. |
||
version |
String |
The version of the service. A value of null means the latest, a value of '*' means all versions. |
3.10. DataStore
Describe a DataStore object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
Id used to identify the data store. |
||
name |
String |
The name of the data store |
||
type |
String |
The type of the data store |
||
dataType |
String |
Data type definition |
||
dataTypeSource |
String |
Optional URI of the source where the type comes from |
||
dataTypeName |
String |
Name of the data type |
||
itemDataTypeName |
String |
Name of the item data type |
||
owner |
String |
User that owns this email if not the caller |
||
member |
String |
A group that the data stores is shared with |
||
columns |
Map of [string] |
Columns description (name, type) |
3.11. DatastoreContentsIdGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of DataStore |
All the data stores for requesting id. |
3.12. DatastoreContentsIdPost200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of DataStore |
All the data stores for requesting user. |
3.13. DeploymentsBpmnEnvironmentGroupIdArtifactIdVersionPostRequest
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
model |
File |
The file to upload. |
binary |
3.14. EmitterDef
Describe a emitter definition object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
The id of the emitter. |
||
type |
String |
The type of the emitter |
||
filter |
String |
The filter expression (in FEEL literal expression format) applied to event data to discard event if it does not match the filter expression |
||
topics |
List of [array] |
List of topics the emitter should be subscribed to. |
||
messages |
List of [string] |
List of messages the emitter should consume. |
||
owner |
String |
The owner of the emitter definition |
||
identityRef |
String |
The identity id (reference to existing identity) for the emitter. Identity can be generated and their id found under the URL: /management/identities |
||
parameters |
Map of [string] |
Additional parameters that are specific for the emitter type. |
3.15. EmitterParameter
Describe a emitter parameter object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
The name of the parameter used by emitter. |
||
description |
String |
The description of the parameter |
||
dataType |
String |
The data type of the parameter |
||
required |
Boolean |
Indicates if the parameter is required |
3.16. EmitterType
Describe a emitter type object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
The name of the emitter. |
||
description |
String |
The description of the emitter |
||
parameters |
List of EmitterParameter |
List parameters that are defined for the emitter type. |
3.17. EmittersDefinitionsGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of EmitterDef |
All the event emitter definitions for requesting user. |
3.18. EmittersDefinitionsIdGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
EmitterDef |
3.19. EmittersGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of EmitterType |
All the event emitter types available in the server. |
3.20. ErrorMessage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
error |
List of [ErrorMessage_error_inner] |
3.21. ErrorMessageErrorInner
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
String |
The error code. |
Enum: ProcessingException, RequiresLogin, Unlicensed, NoFile, AlreadyAMember, InvalidEmail, NoUser, NoRepository, InvalidParameters, NoRight, RepositoryExists, NoProduct, InvalidRepository, InvalidMember, NoSubscription, InvalidPath, DuplicateName, InvalidFileName, InvalidMimeType, NoRequest, NoService, FileUploadError, InvalidSession, FeedbackError, MailError, PermissionException, SendMessageError, |
|
systemMessage |
String |
The system message (not meant for user). |
||
userMessage |
String |
The user message (can be displayed to a user). |
||
reference |
String |
An error reference id used for debugging. |
3.22. Event
Describe an Event.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
guid |
String |
The guid of the CommentEvent. When updating a comment, this field only use to determine which comment to update. |
||
memberEmail |
String |
The email of the member that create the event. When updating or creating a comment, this field is ignore. |
||
memberDisplayName |
String |
The name of the member that create the event. When updating or creating a comment, this field is ignore. |
||
memberImage |
String |
The image of the member that create the event. When updating or creating a comment, this field is ignore. |
||
date |
date |
The date of the event. When updating or creating a comment, this field is ignore. |
date |
|
operationType |
String |
The type of the event. When updating or creating a comment, this field is ignore. |
Enum: CREATE, RESOLVE, UPDATE, COMMENT, |
3.23. EventDef
Describe an event object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
Event id |
||
type |
String |
Event type |
||
time |
Date |
Date event has been emitted |
date-time |
|
data |
Map of [string] |
Event data |
3.24. ExecutionRepository
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
The execution repository name. |
||
hasPerformerAccess |
Boolean |
If the current user can read/perform operations to this execution repository. |
||
hasDeployerAccess |
Boolean |
If the current user can deploy to this execution repository. |
||
hasBuilderAccess |
Boolean |
If the current user can download artifacts/build containers from to this execution repository. |
||
hasAdminAccess |
Boolean |
If the current user can administrate this execution repository. |
||
publicRights |
String |
What global access this execution repository has (none or performer). |
||
trigerActive |
Boolean |
If this execution repository has triggers activated. |
||
enabledHistory |
Boolean |
If this execution repository has instance history enabled. |
||
production |
Boolean |
If this execution repository is production one returns true else false. |
3.25. ExecutionrepositoryDelete200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
ExecutionRepository |
3.26. ExecutionrepositoryGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of ExecutionRepository |
3.27. ExecutionrepositoryartifactGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of GAV |
3.28. ExecutionrepositoryartifactPost200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
GAV |
3.29. File
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
repositoryId |
String |
The place identifier. |
||
id |
String |
The file identifier. |
||
sku |
String |
The file identifier (deprecated). |
||
name |
String |
The file name. |
||
mimetype |
String |
The mimetype of the file. |
||
url |
String |
The URL of the file. You can do a HTTP Get on that URL to retrive the file or do a HTTP Post on the url to store new content in the file. |
||
updater |
String |
The name of the last updater of that file. |
||
updated |
String |
The ISO8601 date/time of the last file modification. |
||
path |
String |
This file path in the repository |
||
version |
String |
This file version in the repository |
||
state |
String |
This file state in the repository |
3.30. FileOrFolder
Either file or folder will be provider
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
file |
FileOrFolder_file |
|||
folder |
FileOrFolder_folder |
3.31. FileOrFolderFile
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
repository |
String |
The place identifier. |
||
id |
String |
The file identifier. |
||
sku |
String |
The file identifier (deprecated). |
||
name |
String |
The file name. |
||
mimetype |
String |
The mimetype of the file. |
||
url |
String |
The URL of the file. You can do a HTTP Get on that URL to retrive the file or do a HTTP Post on the url to store new content in the file. |
||
updater |
String |
The name of the last updater of that file. |
||
updated |
String |
The ISO8601 date/time of the last file modification. |
||
path |
String |
This file path in the repository |
3.32. FileOrFolderFolder
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
repositoryId |
String |
The place identifier. |
||
id |
String |
Thefolder identifier. |
||
sku |
String |
The folder identifier (deprecated). |
||
name |
String |
The folder name. |
||
path |
String |
This folder path in the repository |
3.33. GAV
Describe an artifact in a similar manner as maven.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
groupId |
String |
Group identifier. |
||
artifactId |
Boolean |
Artifact identifier. |
||
version |
String |
Artifact version. |
||
name |
String |
The name of the artifact. |
||
description |
String |
The description of the artifact. |
||
publisherName |
String |
The artifact publisher name. |
||
publisherEmail |
String |
The artifact publisher email. |
||
published |
String |
The artifact publication date in ISO 8601 format |
||
sha1 |
String |
The SHA1 hash of the artifact |
||
container |
String |
The container image reference (if available) |
3.34. GroupDef
Describe a Group definition object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
externalId |
String |
Id used to identify the member. |
||
displayName |
String |
The name of the member |
||
members |
List of Member |
In case this member is a group it can consists of nested members. |
3.35. GroupsGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of GroupDef |
All the Groups in the instance. |
3.37. Identity
Describe an Identity object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
Id used to identify the identity. |
||
name |
String |
The name of the identity |
||
creationDate |
String |
The creation date of the identity |
||
serviceUrl |
String |
The url of the service the identity is associated with |
||
group |
String |
Group identifier if the idenity is shared with a group |
||
owner |
String |
User that owns this email if not the caller |
3.39. IdentityGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of Identity |
All the identities for requesting user (optionally filtered by service url). |
3.40. Issue
Describe an Issue object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Integer |
The id of the issue. When creating a CommentEvent, this field is ignore. |
||
isOpen |
Boolean |
The state of the issue. When creating a CommentEvent, this field is ignore. |
||
title |
String |
The title of the issue. |
||
description |
String |
The description of the issue. |
||
relatedElement |
String |
The related element of the issue. |
||
assignTo |
String |
The email of the person that is assign to the issue. |
||
CommentEvents |
List of UserEvent |
All the events of the issue. The array can have CommentEvent as well as UserEvents inside of it. When updating or creating a issue, this field is ignore. |
3.41. IssueGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of Issue |
Array of issues. |
3.43. IssuecommentGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of UserEvent |
All the CommentEvents of the issue. The array can have ThreadCommentEvents as well as UserEvents inside of it. |
3.45. LogEntry
Log entry.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
severity |
String |
Severity of the log entry |
||
message |
String |
Message of the log entry |
||
transformationId |
String |
Transformation identifier (optional) |
||
objectId |
String |
Id of the object this log entry is associated with (optional) |
||
objectName |
String |
Name of the object this log entry is associated with (optional) |
||
objectType |
String |
Type of the object this log entry is associated with (optional) |
||
error |
String |
Error details in case this entry represents an error (optional) |
||
extendedAttributes |
Map of [string] |
Extended attributes associated with log entry (optional) |
3.47. LoginGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
_login_get_200_response_data |
3.48. LoginGet200ResponseData
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
String |
The member email address. |
|||
name |
String |
The member name. |
||
photoThumbnail |
String |
A URL to a thumbnail photo of the memeber (size 32x32). |
||
photo |
String |
A URL to a full size photo of the member (size will vary). |
3.49. Member
Describe a Member object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
type |
String |
The type of the member - either User or Group. |
||
externalId |
String |
Id used to identify the member. |
||
displayName |
String |
The name of the member |
||
members |
List of Member |
In case this member is a group it can consists of nested members. |
3.51. MimetypeGet200ResponseDataInner
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
The mimetype. |
||
description |
String |
A description of this mime type. |
||
editor |
String |
If accessible, a url to edit models of this mimetype. |
||
portal |
String |
If accessible, a url to display in a portal models of this mimetype. |
||
viewer |
String |
If accessible, a url to view models of this mimetype. |
3.52. Repository
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
The place id. |
||
name |
String |
The place name. |
||
type |
String |
The place type. |
||
members |
String |
The number of members of that group. |
||
rights |
Repository_rights |
|||
publicRights |
String |
The global access rule of the place |
Enum: none, read, write, |
|
productionRight |
Boolean |
The production rights of the place |
3.53. RepositoryGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of Repository |
3.54. RepositoryMember
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
The member name. |
||
String |
The member email. Either email or group id must be given. |
|||
groupId |
String |
The groupm member id. Either email or group id must be given. |
||
type |
String |
The type of the member (User or Group). |
||
rights |
Repository_rights |
3.56. RepositoryRights
The member rights on the group.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
owner |
String |
true if the member is the owner of the place, false otherwize. |
Enum: false, true, |
|
write |
String |
true if the member can write to the place, false if he can only read. |
Enum: false, true, |
3.57. RepositorycontentGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of FileOrFolder |
3.59. RepositoryfileversionGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of File |
3.60. RepositorymemberGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of RepositoryMember |
3.61. RepositorymemberPut200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
RepositoryMember |
3.62. RepositorypromotePost200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
_repositorypromote_post_200_response_data |
3.63. RepositorypromotePost200ResponseData
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
source |
String |
the source place id. |
||
target |
String |
the target place id. |
3.64. RequestaccessGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of AccessRequest |
3.65. ServiceDescriptor
Describe an asset object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
Unique identifier of the service descriptor |
||
type |
String |
Authentication type for the service descriptor |
||
name |
String |
Service descriptor name |
||
serviceUrl |
String |
Server URL that this descriptor relates to |
||
updated |
Date |
Last update date and time |
date-time |
|
options |
Object |
Additional options related to the authentication type |
3.66. ServiceInstanceMigrationStatus
Describe a service instance migration status.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
modelId |
String |
Identifier of the model |
||
modelName |
String |
Name of the model |
||
instanceId |
String |
Unique identifier of the service instance |
||
instanceName |
String |
Name of the service instance |
||
status |
String |
Migration status - Success or Failure |
||
message |
String |
Additional message in case of a failure |
3.67. ServiceMigrationContext
Describe an validation issue.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
deleteMigrated |
Boolean |
Indicates if migrated service instance should be directly removed |
||
processNodes |
Map of [array] |
Mapping of nodes for given model id |
||
modelIdsMapping |
Object |
Mapping of model identifiers |
3.68. ServiceMigrationContextProcessNodesValueInner
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
Identifier of the node in source service |
||
mappedTo |
String |
Identifier of the node in targer service |
3.69. ServiceMigrationReport
Describe an validation issue.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
numberOfInstancesInScope |
BigDecimal |
Number of service instances in the scope of migration |
||
migrated |
List of ServiceInstanceMigrationStatus |
Service instance details that was successfully migrated |
||
failed |
List of ServiceInstanceMigrationStatus |
Service instance details that failed during migration |
||
skipped |
List of ServiceInstanceMigrationStatus |
Service instance details that was skipped during migration |
3.70. TestdataGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of [string] |
All test data types available. |
3.71. TestdataTypeGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of [string] |
All test data file names available for given type. |
3.72. User
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
The user full name. |
||
String |
The user email address. |
3.73. UserEvent
Describe an UserEvent.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
guid |
String |
The guid of the CommentEvent. When updating a comment, this field only use to determine which comment to update. |
||
memberEmail |
String |
The email of the member that create the event. When updating or creating a comment, this field is ignore. |
||
memberDisplayName |
String |
The name of the member that create the event. When updating or creating a comment, this field is ignore. |
||
memberImage |
String |
The image of the member that create the event. When updating or creating a comment, this field is ignore. |
||
date |
date |
The date of the event. When updating or creating a comment, this field is ignore. |
date |
|
operationType |
String |
The type of the event. When updating or creating a comment, this field is ignore. |
Enum: CREATE, RESOLVE, UPDATE, COMMENT, |
|
updatedField |
String |
Indicate what field has been updated in the event. |
||
oldValue |
String |
Indicate what the value of the field was before the event occurs. |
||
newValue |
String |
Indicate what the value of the field was after the event occurs. |
3.74. UserEventAllOf
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
updatedField |
String |
Indicate what field has been updated in the event. |
||
oldValue |
String |
Indicate what the value of the field was before the event occurs. |
||
newValue |
String |
Indicate what the value of the field was after the event occurs. |
||
operationType |
String |
The type of the event. When updating or creating a comment, this field is ignore. |
Enum: CREATE, RESOLVE, UPDATE, COMMENT, |
3.75. UserGet200Response
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
List of User |
3.76. UserTasksInner
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
String |
|||
taskName |
String |
|||
taskDescription |
String |
|||
state |
String |
|||
startDate |
Date |
date-time |
||
processId |
String |
|||
processInstanceId |
String |
|||
processInstanceName |
String |
|||
processInstanceTags |
List of [string] |
|||
actualOwner |
String |
|||
potentialUsers |
List of [string] |
|||
potentialGroups |
List of [string] |
|||
formUrl |
String |
|||
restUrl |
String |
|||
repository |
String |
|||
group |
String |
|||
artifact |
String |
|||
version |
String |
2.13.1. DELETE /issuecomment
issuecommentDelete
Delete a CommentEvent of a Issue.
Description
Parameters
Query Parameters
repository
The repository id.
X
null
issueId
The issue id.
X
null
commentId
The CommentEvent id.
X
null
Return Type
[_issuecomment_put_200_response]
Content Type
application/json
Responses
200
CommentEvent deleted.
[_issuecomment_put_200_response]
500
An error occurred.
ErrorMessage
Samples