ActivityDocumentation
Use this resource to retrieve documentation for an activity.
Method summary
| HTTP Method | Path | Description |
|---|---|---|
| GET | /scr/api/ActivityDocumentation | Retrieves documentation for an activity. |
GET /scr/api/ActivityDocumentation
- Description
- Use this method to retrieve documentation for an activity.
- Resource information
-
Requirements Description Response format JSON Requires authentication Yes. The user must have at least participant access to the process that contains the activity for which the documentation is retrieved. Supports OAuth 2 client credentials Yes using a User Service ID containing Artifact Reporting Category Rate limited Not yet
- Parameters
-
Name Location Description Required Type X-On-Behalf-Of Header The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String activityId Query The ID of the activity for which the documentation is retrieved. Yes String processId Query The ID of the process that contains the activity. Yes String
- Response
-
- Example input
-
- Using User Service ID OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/ActivityDocumentation?processId=80012&activityId=5f500e10928f0" - Using Service ID OAuth 2 client
credentials:
curl -i -H "Authorization: Bearer access_token" "https://your_server_url/scr/api/ActivityDocumentation?processId=80012&activityId=5f500e10928f0" - Using OAuth 2 client credentials with user
context:
curl -i -H "Authorization: Bearer access_token" "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/scr/api/ActivityDocumentation?processId=80012&activityId=5f500e10928f0"
- Using User Service ID OAuth 2 client
credentials:
- Example output
-
{ "activityId":"5f500e10928f0", "description":"<b><i><u>ActivityDocumentation API test<\/u><\/i><\/b>" }
- Response properties
-
- activityId
- The ID of the requested activity.
- description
- The activity documentation that contains HTML markup entered by the user. This property is not present if there is no documentation.
- Response messages
-
HTTP code Reason 200 The request was completed successfully.
400 There was an error processing the request. Required parameters were missing or contained invalid values.
401 The user isn't authorized to make the request.
403 The user does not have access to the process. The process requires at least participant access.