Data
Access to Data resources.
API | Description |
---|---|
GET {repositoryId}/Data/{id} |
Reads a Data resource by ID. |
GET {repositoryId}/Data/{id}/Lock |
Locks and reads a Data resource by ID. |
GET {repositoryId}/Data/New?modelUrl={modelUrl} |
Returns a new Data resource. |
POST {repositoryId}/Data |
Creates a Data resource. |
PUT {repositoryId}/Data/{id} |
Updates a Data resource. |
PUT {repositoryId}/Data/{id}/Unlock |
Updates and unlocks a Data resource. |
DELETE {repositoryId}/Data/{id} |
Deletes a Data resource. |
POST {repositoryId}/Data/{id}/Lock |
Locks a Data resource. |
POST {repositoryId}/Data/{id}/Unlock |
Unlocks a Data resource. |
GET {repositoryId}/Data/{id}/Exists |
Determines if a Data exists. |
POST {repositoryId}/Data/Catalog |
Returns the catalog for Data resources. |
GET {repositoryId}/Data/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for Data resources. |
POST {repositoryId}/Data/Catalog/Count |
Returns the number of elements in the catalog for Data resources. |
GET {repositoryId}/Data/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for Data resources. |
GET {repositoryId}/Data/{id}/Actions?modelUrl={modelUrl}&applyBehaviour={applyBehaviour} |
Gets the list of available Actions for the given resource. |
POST {repositoryId}/Data/{id}/CustomAction |
Executes a custom action on the specified resource. |
GET {repositoryId}/Data/{id}/Attachment/List |
Gets the list of all the attachments for the specified resource. |
GET {repositoryId}/Data/{id}/Attachment/{attachmentId} |
Downloads an Attachment from a Data resource. |
POST {repositoryId}/Data/{id}/Attachment?fileName={fileName} |
Adds an attachment to a Data resource. |
PUT {repositoryId}/Data/{id}/Attachment/{attachmentId} |
Updates the content of an attachment for the specified resource (the file name doesn't change). |
DELETE {repositoryId}/Data/{id}/Attachment/{attachmentId} |
Deletes the specified attachment. |
GET {repositoryId}/Data/{id}/Attachment/{attachmentId}/Info |
Gets information about the specified attachment. |
GET {repositoryId}/Data/{id}/Attachment/Info |
Gets the list of info for all the attachments to the specified resource. |
PUT {repositoryId}/Data/{id}/Attachment/{attachmentId}/FileName |
Updates the file name of the specified attachment. |
POST {repositoryId}/Data/{id}/TrackingMessage?overwrite={overwrite} |
Creates a TrackingMessage. |
POST {repositoryId}/Data/TrackingMessage?overwrite={overwrite} |
Creates a TrackingMessage using its SendId. |
GET {repositoryId}/Data/{id}/TrackingMessage/{messageId} |
Reads a TrackingMessage. |
POST {repositoryId}/Data/{id}/Attachment/Tracking?fileName={fileName}&tag={tag} |
Adds an attachment related to a TrackingMessage to a Data resource. |
POST {repositoryId}/Data/{id}/TrackingMessage/Catalog |
Returns a catalog of TrackingMessages related to a Data resource. |
GET {repositoryId}/Data/{id}/TrackingMessage/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns a catalog of TrackingMessages related to a Data resource. |
GET {repositoryId}/Data/{id}/SendingReport |
Returns a list of CorrespondentInfo. |
POST {repositoryId}/Data/{id}/Sending |
Starts the sending process of a Data resource. |
POST {repositoryId}/Data/{id}/SimpleSending |
Starts the sending process of a Data resource. |
PUT {repositoryId}/Data/{id}/Paths |
Adds a list of sending paths to a Data resource. |
PUT {repositoryId}/Data/{id}/Path |
Adds a sending path to a Data resorce. |
DELETE {repositoryId}/Data/{id}/Sending |
Aborts the sending process of a Data resource. |
POST {repositoryId}/Data/{id}/Receiving |
Starts the receiving process of a Data resource. |
Process
Access to Process resources.
API | Description |
---|---|
POST {repositoryId}/Process/Sync?modelUrl={modelUrl} |
Executes a syncronous process. |
POST {repositoryId}/Process/Async?modelUrl={modelUrl} |
Creates an asyncronous process. |
PUT {repositoryId}/Process/{id}/Suspend |
Suspends a Process instance. |
PUT {repositoryId}/Process/{id}/Resume |
Resumes a suspended Process instance. |
PUT {repositoryId}/Process/{id}/Abort |
Aborts a Process instance. |
GET {repositoryId}/Process/{id}/Output |
Gets a process output. |
GET {repositoryId}/Process/{id}/Status |
Gets a process status. |
DELETE {repositoryId}/Process/{id} |
Deletes a Process instance. |
POST {repositoryId}/Process/Catalog |
Returns the catalog for Process instances. |
POST {repositoryId}/Process/Archived/Catalog |
Returns the catalog for archived Process instances. |
GET {repositoryId}/Process/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for Process instances. |
GET {repositoryId}/Process/Archived/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for archived Process instances. |
POST {repositoryId}/Process/Catalog/Count |
Returns the number of elements in the catalog for Process resources. |
GET {repositoryId}/Process/Catalog/Count |
Returns the number of elements in the catalog for Process resources. |
GET {repositoryId}/Process/{id}/Actions |
Gets the list of available Actions for the given Process instance. |
GET {repositoryId}/Process/Models/Catalog |
Returns the catalog for instantiable process models. |
Organization
Access to Organization, OrganizationalPosition, OrganizationalUnit, OrganizationalBlock and OrganizationalAssignment resources.
API | Description |
---|---|
GET {repositoryId}/OrganizationalPosition/{id}/FirstLevelManagerPosition |
Gets the first level manager position of the given organizational position. |
GET {repositoryId}/OrganizationalUnit/{id}/FirstLevelManagerPosition |
Gets the first level manager position of the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/SecondLevelManagerPosition |
Gets the second level manager position of the given organizational position. |
GET {repositoryId}/OrganizationalUnit/{id}/SecondLevelManagerPosition |
Gets the second level manager position of the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/TopLevelManagerPosition?excludeRootLevel={excludeRootLevel} |
Gets the top level manager position of the given organizational position. |
GET {repositoryId}/OrganizationalUnit/{id}/TopLevelManagerPosition?excludeRootLevel={excludeRootLevel} |
Gets the top level manager position of the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/ParentUnit |
Gets the parent organizational unit of the given organizational position. |
GET {repositoryId}/OrganizationalUnit/{id}/ParentUnit |
Gets the parent organizational unit of the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/TopLevelUnit?excludeRootLevel={excludeRootLevel} |
Gets the top level organizational unit of the given organizational position. |
GET {repositoryId}/OrganizationalUnit/{id}/TopLevelUnit?excludeRootLevel={excludeRootLevel} |
Gets the top level organizational unit of the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/PositionsReportingTo?includeAllLevels={includeAllLevels} |
Gets the list of references to the positions that are depending from the given position. |
GET {repositoryId}/OrganizationalUnit/{id}/PositionsReportingTo?includeAllLevels={includeAllLevels} |
Gets the list of references to the positions that are depending from the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/UnitsReportingTo?includeAllLevels={includeAllLevels} |
Gets the list of references to the units that reports to the given position. |
GET {repositoryId}/OrganizationalUnit/{id}/UnitsReportingTo?includeAllLevels={includeAllLevels} |
Gets the list of references to the units that reports to the given organizational unit. |
GET {repositoryId}/OrganizationalBlock/{id}/UnitsInBlock |
Gets the list of the references to the units belonging to the given organizational block. |
GET {repositoryId}/OrganizationalPosition/{id}/StaffReportingTo?includeAllLevels={includeAllLevels}&includeAllPeriods={includeAllPeriods}&onlyPrimary={onlyPrimary} |
Gets the list of references to the identities that are subordinated to the given position. |
GET {repositoryId}/OrganizationalUnit/{id}/StaffReportingTo?includeAllLevels={includeAllLevels}&includeAllPeriods={includeAllPeriods}&onlyPrimary={onlyPrimary} |
Gets the list of references to the identities that are subordinated to the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/Assignments?includeAllPeriods={includeAllPeriods}&onlyPrimary={onlyPrimary} |
Gets the list of references to the assignments of the given position. |
GET {repositoryId}/OrganizationalPosition/{id}/Staff?includeAllPeriods={includeAllPeriods}&onlyPrimary={onlyPrimary} |
Gets the list of references to the identities associated to the given position. |
GET {repositoryId}/OrganizationalPosition/{id}/BelongsToOrganization/{organizationId} |
Checks if the position belongs to the given organization. |
GET {repositoryId}/OrganizationalUnit/{id}/BelongsToOrganization/{organizationId} |
Checks if the unit belongs to the given organization. |
GET {repositoryId}/OrganizationalBlock/{id}/BelongsToOrganization/{organizationId} |
Checks if the block belongs to the given organization. |
GET {repositoryId}/OrganizationalPosition/{id}/BelongsToOrganizationalUnit/{organizationalUnitId} |
Checks if the position belongs to the given unit. |
GET {repositoryId}/OrganizationalUnit/{id}/BelongsToOrganizationalUnit/{organizationalUnitId} |
Checks if the unit belongs to the given unit. |
GET {repositoryId}/OrganizationalPosition/{id}/BelongsToOrganizationalUnitHierarchy/{organizationalUnitId} |
Checks if the position is in the hierarchy of to the given organizational unit. |
GET {repositoryId}/OrganizationalUnit/{id}/BelongsToOrganizationalUnitHierarchy/{organizationalUnitId} |
Checks if the unit is in the hierarchy of to the given organizational unit. |
GET {repositoryId}/OrganizationalPosition/{id}/BelongsToOrganizationalBlock/{organizationalBlockId} |
Checks if the position belongs to the given organizational block. |
GET {repositoryId}/OrganizationalUnit/{id}/BelongsToOrganizationalBlock/{organizationalBlockId} |
Checks if the unit belongs to the given organizational block. |
GET {repositoryId}/OrganizationalPosition/{id}/PositionManagerIs/{organizationalPositionId} |
Checks if the position has the given position as position manager. |
GET {repositoryId}/OrganizationalUnit/{id}/PositionManagerIs/{organizationalPositionId} |
Checks if the unit has the given position as position manager. |
GET {repositoryId}/OrganizationalPosition/{id}/FirstLevelManagerPositionIs/{organizationalPositionId} |
Checks if the position has the given position as first level position manager. |
GET {repositoryId}/OrganizationalUnit/{id}/FirstLevelManagerPositionIs/{organizationalPositionId} |
Checks if the unit has the given position as first level position manager. |
GET {repositoryId}/OrganizationalPosition/{id}/SecondLevelManagerPositionIs/{organizationalPositionId} |
Checks if the position has the given position as second level position manager. |
GET {repositoryId}/OrganizationalUnit/{id}/SecondLevelManagerPositionIs/{organizationalPositionId} |
Checks if the unit has the given position as second level position manager. |
GET {repositoryId}/OrganizationalPosition/{id}/IsFirstLevelManagerPositionOfPosition/{organizationalPositionId} |
Checks if the given organizational position is first level manager of the given position. |
GET {repositoryId}/OrganizationalPosition/{id}/IsFirstLevelManagerPositionOfUnit/{organizationalUnitId} |
Checks if the given organizational position is first level manager of the given unit. |
GET {repositoryId}/OrganizationalPosition/{id}/IsSecondLevelManagerPositionOfPosition/{organizationalPositionId} |
Checks if the given organizational position is second level manager of the given position. |
GET {repositoryId}/OrganizationalPosition/{id}/IsSecondLevelManagerPositionOfUnit/{organizationalUnitId} |
Checks if the given organizational position is second level manager of the given unit. |
POST {repositoryId}/Organization/Catalog |
Returns the catalog for Organization resources. |
GET {repositoryId}/Organization/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for Organization resources. |
POST {repositoryId}/Organization/Catalog/Count |
Returns the number of elements in the catalog for Organization resources. |
GET {repositoryId}/Organization/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for Organization resources. |
POST {repositoryId}/OrganizationalAssignment/Catalog/Count |
Returns the number of elements in the catalog for OrganizationalAssignment resources. |
GET {repositoryId}/OrganizationalAssignment/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for OrganizationalAssignment resources. |
POST {repositoryId}/OrganizationalBlock/Catalog/Count |
Returns the number of elements in the catalog for OrganizationalBlock resources. |
GET {repositoryId}/OrganizationalBlock/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for OrganizationalBlock resources. |
POST {repositoryId}/OrganizationalPosition/Catalog/Count |
Returns the number of elements in the catalog for OrganizationalPosition resources. |
GET {repositoryId}/OrganizationalPosition/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for OrganizationalPosition resources. |
POST {repositoryId}/OrganizationalUnit/Catalog/Count |
Returns the number of elements in the catalog for OrganizationalUnit resources. |
GET {repositoryId}/OrganizationalUnit/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for OrganizationalUnit resources. |
POST {repositoryId}/OrganizationalPosition/Catalog |
Returns the catalog for OrganizationalPosition resources. |
GET {repositoryId}/OrganizationalPosition/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for OrganizationalPosition resources. |
POST {repositoryId}/OrganizationalUnit/Catalog |
Returns the catalog for OrganizationalUnit resources. |
GET {repositoryId}/OrganizationalUnit/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for OrganizationalUnit resources. |
POST {repositoryId}/OrganizationalBlock/Catalog |
Returns the catalog for OrganizationalBlock resources. |
GET {repositoryId}/OrganizationalBlock/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for OrganizationalBlock resources. |
POST {repositoryId}/OrganizationalAssignment/Catalog |
Returns the catalog for OrganizationalAssignment resources. |
GET {repositoryId}/OrganizationalAssignment/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for OrganizationalAssignment resources. |
GET {repositoryId}/OrganizationalAssignment/{id} |
Reads an OrganizationalAssignment resource by ID. |
GET {repositoryId}/OrganizationalAssignment/{id}/Lock |
Locks and reads an OrganizationalAssignment resource by ID. |
GET {repositoryId}/Organization/{id} |
Reads an Organization resource by ID. |
GET {repositoryId}/OrganizationalUnit/{id} |
Reads an OrganizationalUnit resource by ID. |
GET {repositoryId}/OrganizationalPosition/{id} |
Reads an OrganizationalPosition resource by ID. |
GET {repositoryId}/OrganizationalBlock/{id} |
Reads an OrganizationalBlock resource by ID. |
GET {repositoryId}/OrganizationalAssignment/New?modelUrl={modelUrl} |
Returns a new OrganizationalAssignment resource. |
POST {repositoryId}/OrganizationalAssignment |
Creates an OrganizationalAssignment resource. |
PUT {repositoryId}/OrganizationalAssignment/{id} |
Updates an OrganizationalAssignment resource. |
PUT {repositoryId}/OrganizationalAssignment/{id}/Unlock |
Updates and unlocks an OrganizationalAssignment resource. |
DELETE {repositoryId}/OrganizationalAssignment/{id} |
Deletes an OrganizationalAssignment resource. |
POST {repositoryId}/OrganizationalAssignment/{id}/Lock |
Locks an OrganizationalAssignment resource. |
POST {repositoryId}/OrganizationalAssignment/{id}/Unlock |
Unlocks an OrganizationalAssignment resource. |
GET {repositoryId}/OrganizationalAssignment/{id}/Actions?modelUrl={modelUrl}&applyBehaviour={applyBehaviour} |
Gets the list of available Actions for the given resource. |
POST {repositoryId}/OrganizationalAssignment/{id}/CustomAction |
Executes a custom action on the specified resource. |
GET {repositoryId}/Organization/{id}/Exists |
Determines if an Organization exists. |
GET {repositoryId}/OrganizationalPosition/{id}/Exists |
Determines if an Organizational Position exists. |
GET {repositoryId}/OrganizationalUnit/{id}/Exists |
Determines if an Organizational Unit exists. |
GET {repositoryId}/OrganizationalBlock/{id}/Exists |
Determines if an Organizational Block exists. |
GET {repositoryId}/OrganizationalAssignment/{id}/Exists |
Determines if an Organizational Assignment exists. |
Event
Access to Event resources.
API | Description |
---|---|
GET {repositoryId}/Event/{id} |
Reads an EventEnvelope resource by ID. |
POST Event/Envelope |
Creates an EventEnvelope resource. |
POST {repositoryId}/Event/Message |
Publishes an Event Message. |
POST {repositoryId}/Event/Custom |
Publishes a Custom Event. |
POST {repositoryId}/Event/Extensions/Catalog |
Returns the extensions catalog. |
GET {repositoryId}/Event/Extensions/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the extensions catalog. |
Session
Access to Session resources.
API | Description |
---|---|
GET Session/Current |
Reads information on the current Session. |
GET Session/ExternalProviderConfiguration |
Reads information on the external provider configuration |
POST Session |
Creates a new Session. |
POST Session/External |
Creates a new Session through an external authentication provider. |
PUT Session/CurrentPosition |
Sets the current Position for the user session (Token header required) |
PUT Session/KeepAlive |
Keeps the current session open (Token header required) |
GET Session/Positions |
Gets the positions associated to the user logged in the current session |
DELETE Session/Current |
Deletes the current Session. |
Identity
Access to Identity, Account, AccountCriteria and PasswordCriteria resources.
API | Description |
---|---|
GET {repositoryId}/Identity/{id} |
Reads an Identity resource by ID. |
GET {repositoryId}/Identity/{id}/Lock |
Locks and reads an Identity resource by ID. |
GET {repositoryId}/Identity/New?modelUrl={modelUrl} |
Returns a new Identity resource. |
POST {repositoryId}/Identity |
Creates an Identity resource. |
PUT {repositoryId}/Identity/{id} |
Updates an Identity resource. |
PUT {repositoryId}/Identity/{id}/Unlock |
Updates and unlocks an Identity resource. |
DELETE {repositoryId}/Identity/{id} |
Deletes an Identity resource. |
POST {repositoryId}/Identity/{id}/Lock |
Locks an Identity resource. |
POST {repositoryId}/Identity/{id}/Unlock |
Unlocks an Identity resource. |
GET {repositoryId}/Identity/{id}/Exists |
Determines if an Identity exists. |
POST {repositoryId}/Identity/Catalog |
Returns the catalog for Identity resources. |
GET {repositoryId}/Identity/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for Identity resources. |
POST {repositoryId}/Identity/Catalog/Count |
Returns the catalog for Identity resources. |
GET {repositoryId}/Identity/Catalog/Count?modelUrl={modelUrl} |
Returns the count catalog for Account resources. |
GET {repositoryId}/Identity/{id}/Actions?modelUrl={modelUrl}&applyBehaviour={applyBehaviour} |
Gets the list of available Actions for the given resource. |
POST {repositoryId}/Identity/{id}/CustomAction |
Executes a custom action on the specified resource. |
GET {repositoryId}/Account/{id} |
Reads an Account resource by ID. |
GET {repositoryId}/Account?userName={userName} |
Reads an Account resource by UserName. |
GET {repositoryId}/Account/New?id={id} |
Returns a new Account resource. |
POST {repositoryId}/Account?password={password} |
Creates an Account resource. |
PUT {repositoryId}/Account/{id}/Password/{password} |
Sets a new password for the given account. |
PUT {repositoryId}/Account/{id}/RandomPassword |
Sets a random password for the given account. |
PUT {repositoryId}/Account/{id}/Enable |
Enables the given account. |
PUT {repositoryId}/Account/{id}/Disable |
Disables the given account. |
GET {repositoryId}/Account/{id}/UserName |
Gets the UserName from an Account resource by ID. |
PUT {repositoryId}/Account/{id} |
Updates an Account resource. |
DELETE {repositoryId}/Account/{id} |
Deletes an Account resource. |
DELETE {repositoryId}/Account?userName={userName} |
Deletes an Account resource by UserName. |
GET {repositoryId}/Account/{id}/Exists |
Determines if an Account exists. |
POST {repositoryId}/Account/Catalog |
Returns the catalog for Account resources. |
GET {repositoryId}/Account/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for Account resources. |
POST {repositoryId}/Account/Catalog/Count |
Returns the number of elements in the catalog for Account resources. |
GET {repositoryId}/Account/Catalog/Count |
Returns the number of elements in the catalog for Account resources. |
GET {repositoryId}/Account/{id}/Actions |
Gets the list of available Actions for the given resource. |
GET {repositoryId}/AccountCriteria/{id} |
Reads an AccountCriteria resource by ID. |
GET {repositoryId}/AccountCriteria/New |
Returns a new AccountCriteria resource. |
POST {repositoryId}/AccountCriteria |
Creates an AccountCriteria resource. |
PUT {repositoryId}/AccountCriteria/{id} |
Updates an AccountCriteria resource. |
DELETE {repositoryId}/AccountCriteria/{id} |
Deletes an AccountCriteria resource. |
GET {repositoryId}/AccountCriteria/{id}/Exists |
Determines if an AccountCriteria exists. |
POST {repositoryId}/AccountCriteria/Catalog |
Returns the catalog for AccountCriteria resources. |
GET {repositoryId}/AccountCriteria/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for AccountCriteria resources. |
GET {repositoryId}/AccountCriteria/Actions |
Gets the list of available Actions for AccountCriteria resources. |
GET {repositoryId}/PasswordCriteria/{id} |
Reads a PasswordCriteria resource by ID. |
GET {repositoryId}/PasswordCriteria/New |
Returns a new PasswordCriteria resource. |
POST {repositoryId}/PasswordCriteria |
Creates a PasswordCriteria resource. |
PUT {repositoryId}/PasswordCriteria/{id} |
Updates a PasswordCriteria resource. |
DELETE {repositoryId}/PasswordCriteria/{id} |
Deletes a PasswordCriteria resource. |
GET {repositoryId}/PasswordCriteria/{id}/Exists |
Determines if a PasswordCriteria exists. |
POST {repositoryId}/PasswordCriteria/Catalog |
Returns the catalog for PasswordCriteria resources. |
GET {repositoryId}/PasswordCriteria/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for PasswordCriteria resources. |
GET {repositoryId}/PasswordCriteria/Actions |
Gets the list of available Actions for PasswordCriteria resources. |
GET {repositoryId}/Notification/{id} |
Reads a Notification resource by ID. |
GET {repositoryId}/Notification/New |
Returns a new Notification resource. |
POST {repositoryId}/Notification |
Sends a Notification. |
DELETE {repositoryId}/Notification/{id} |
Deletes a Notification. |
GET {repositoryId}/Notifications/Exist?since={since} |
Checks for the unread notifications since the specified date. |
POST {repositoryId}/Notification/Catalog |
Returns the catalog for Notification resources. |
GET {repositoryId}/Notification/Catalog?pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for Notification resources. |
HumanTask
Access to HumanTask resources.
API | Description |
---|---|
GET {repositoryId}/HumanTask/{id} |
Reads a HumanTask resource by ID. |
GET {repositoryId}/HumanTask/{id}/IgnoreLean |
Reads a HumanTask resource by ID, disregarding the LeanTask flag. |
PUT {repositoryId}/HumanTask/{id} |
Updates a HumanTask resource. |
DELETE {repositoryId}/HumanTask/{id} |
Deletes a HumanTask resource. |
POST {repositoryId}/HumanTask/{id}/Comment |
Adds a comment to a HumanTask resource. |
PUT {repositoryId}/HumanTask/Comment/{id} |
Updates a Comment. |
DELETE {repositoryId}/HumanTask/Comment/{id} |
Deletes a Comment. |
GET {repositoryId}/HumanTask/{id}/Comment/List |
Gets the list of comments (the whole discussion) associated to the specified HumanTask resource. |
POST {repositoryId}/HumanTask/Catalog |
Returns the catalog for HumanTask resources. |
POST {repositoryId}/HumanTask/Catalog/Count |
Returns the number of elements in the catalog for HumanTask resources. |
GET {repositoryId}/HumanTask/Catalog/Count?modelUrl={modelUrl} |
Returns the number of elements in the catalog for HumanTask resources. |
POST {repositoryId}/HumanTask/Catalog/Administration/Count |
Returns the number of elements in the administration catalog for HumanTask resources. |
GET {repositoryId}/HumanTask/Catalog/Administration/Count?modelUrl={modelUrl} |
Returns the number of elements in the administration catalog for HumanTask resources. |
GET {repositoryId}/HumanTask/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the catalog for HumanTask resources. |
POST {repositoryId}/HumanTask/Catalog/Administration |
Returns the administration catalog for HumanTask resources. |
GET {repositoryId}/HumanTask/Catalog/Administration?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber} |
Returns the administration catalog for HumanTask resources. |
PUT {repositoryId}/HumanTask/{id}/Priority/{priority} |
Sets the priority of a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Outcome/{outcomeCode} |
Sets the chosen outcome of a HumanTask. |
GET {repositoryId}/HumanTask/{id}/Exists |
Determines if a HumanTask exists. |
PUT {repositoryId}/HumanTask/{id}/Start |
Starts a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Activate |
Activates a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Suspend |
Suspends a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/SuspendUntil/{suspendTimeOut} |
Suspends a HumanTask until the specified date. |
PUT {repositoryId}/HumanTask/{id}/Resume |
Resumes a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Remove |
Removes a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Exit |
Exits a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Claim |
Claims a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Complete |
Completes a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Release |
Releases a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Skip |
Skips a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Stop |
Stops a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Escalate/{escalationCode} |
Escalates a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Forward |
Forwards a HumanTask. |
PUT {repositoryId}/HumanTask/{id}/Delegate |
Delegates a HumanTask. |
GET {repositoryId}/HumanTask/{id}/Actions?applyBehaviour={applyBehaviour} |
Gets the list of available Actions for the given resource. |
POST {repositoryId}/HumanTask/{id}/CustomAction |
Executes a custom action on the specified resource. |
GET {repositoryId}/HumanTask/{id}/PotentialOwners |
Gets the list of PotentialOwners associated to the specified HumanTask resource, |
GET {repositoryId}/HumanTask/{id}/BusinessAdministrators |
Gets the list of BusinessAdministrators associated to the specified HumanTask resource, |
GET {repositoryId}/HumanTask/{id}/TaskStakeholders |
Gets the list of TaskStakeholders associated to the specified HumanTask resource, |
GET {repositoryId}/HumanTask/{id}/Attachment/List |
Gets the list of all the attachments for the specified resource. |
GET {repositoryId}/HumanTask/{id}/Attachment/{attachmentId} |
Downloads an Attachment from a HumanTask resource. |
POST {repositoryId}/HumanTask/{id}/Attachment?fileName={fileName} |
Adds an attachment to a HumanTask resource. |
PUT {repositoryId}/HumanTask/{id}/Attachment/{attachmentId} |
Updates the content of an attachment for the specified resource (the file name doesn't change). |
DELETE {repositoryId}/HumanTask/{id}/Attachment/{attachmentId} |
Deletes the specified attachment. |
GET {repositoryId}/HumanTask/{id}/Attachment/{attachmentId}/Info |
Gets information about the specified attachment. |
GET {repositoryId}/v/{id}/Attachment/Info |
Gets the list of info for all the attachments to the specified resource. |
PUT {repositoryId}/HumanTask/{id}/Attachment/{attachmentId}/FileName |
Updates the file name of the specified attachment. |