GET Client/Work
Returns a list of work that applies to Groups. Agents and Trust Protection Platform perform work as part of the process of managing certificates. UI changes are available to the Web SDK after several minutes.
DID YOU KNOW? Work refers to automated tasks that include configurations and operations. These tasks use SSH connections or Venafi Server Agents that are installed on various systems in your network.
Requirements
- Permissions: The caller must have Read permission, Write permission, and Create permission.
- Token scope: Agent
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
When adding query parameters, use the /? syntax. If you are not passing any parameters, make sure the URL ends with a trailing slash. Otherwise, some environments, such as cURL and PowerShell, return a HTTP 307 Temporary Redirect message.
Name |
Description |
---|---|
WorkType |
(Optional) The tasks that a group of agents can perform. Task actions may be based on Group Membership Criteria rules. The following WorkTypes are available:
|
Returns
Name |
Description |
---|---|
HTTP 400 |
Bad Request and the reason for failure. |
HTTP 204 |
No client data was found. If necessary, adjust your input parameters and retry. |
HTTP 307 |
If the method is missing a slash (/) at the end of the URL or between the query parameters, this message appears: There is no operation listening for [Web SDK method], but there is an operation listening for [Web SDK method/], so you are being redirected there. |
HTTP 200 |
|
Example: List all groups that do automatic upgrade work
Request for Example
GET https://tpp.venafi.example/vedsdk/Client/work/?worktype=Client Agent Automatic Upgrade Work Authorization:Bearer 4MyGeneratedBearerTknz==
Response for Example
HTTP/1.1 200 OK [ { "AssociatedGroups": [ "G1" ], "WorkDn": "\VED\Clients\Works\G1\Agent Upgrade", "WorkName": "Agent Upgrade", "WorkType": "Client Agent Automatic Upgrade Work" }, { "AssociatedGroups": [ "G1" ], "WorkDn": "\VED\Clients\Works\G1\Agent Connectivity", "WorkName": "Agent Connectivity", "WorkType": "Client Agent Configuration Work" } ]