Manage Job Participants Via API

Previously, only internal API endpoints could be used to manage job participants, which limited external automation and integration.

The new API endpoints let developers manage job participants. They can add, remove, and list participants using secure requests. Adding participant management to existing workflows makes job administration more efficient.

Access to these endpoints lets developers automate and tailor workflows based on their needs. This streamlines collaboration and user experience. This facilitates the work of budget coordinators and users who require joint access to jobs, as it unifies coordination and communication processes.

By making this API available to external users, we aim to boost productivity and interoperability.

HTTP Method

Endpoint

Description

GET

/dse/rest/v1/dse-object/{instanceId}/{l10nLocaleId}/participants

Retrieve list of participants for a job

PATCH

/dse/rest/v1/dse-object/{instanceId}/{l10nLocaleId}/participants

Add new participants to a job (without replacing existing ones)

PUT

/dse/rest/v1/dse-object/{instanceId}/{l10nLocaleId}/participants

Add new participants to a job (replacing existing ones)

DELETE

/dse/rest/v1/dse-object/{instanceId}/{l10nLocaleId}/participants/{userUUID}

Remove a specific participant from a job

Note

  • {instanceId} represents the ID of the job instance.

  • {l10nLocaleId} is the localization ID (always "0" for jobs).

  • {userUUID} is the UUID of the participant to be removed.

These endpoints allow for retrieving, adding, updating, and removing job participants via the external API.