blueprints/{blueprint-id}/activities/{activity-id}/details

Use this resource to update activity details within a specified blueprint.

Method summary

HTTP Method Path Description
PUT /bwl/blueprints/{blueprint-id}/activities/{activity-id}/details Update activity details within a blueprint

PUT /bwl/blueprints/{blueprint-id}/activities/{activity-id}/details

Description
Use this method to update activity details within a blueprint.
Important: First, run glossary_values_categories glossary-values/categories to retrieve information about the properties you want to update. Use the output of that API to complete the parameters for this API.
Resource information
Requirements Description
Response format JSON
Requires authentication Yes
Supports OAuth 2 client credentials Yes using a User Service ID containing Artifact Authoring Category
Rate limited IBM Blueworks Live applies a rate limit that determines how often this API can be called within a specific period. The allowed rate is 200 requests per hour.

The rate limit is applied to the whole account. Even if different authentication methods are used, the single account-wide rate is applied across all users.

Once the rate limit for the API is exceeded for the account, the next request is rejected with status code 429 and response header Retry-After, which indicates the number of seconds when the next request can be made.

Parameters
Name Location Description Required Type
Content type Header The value must be application/json Required when there is content in the request body String
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 blueprint, if any. Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential. String
blueprint-id Path The identifier of the blueprint. Yes String
activity-id Path The identifier of the activity. Yes String
Request JSON body

The request body is a JSON object containing the following properties:

Name Location Description Required Type
name JSON body The name of the item. Yes String
participants JSON body The ID of the glossary value of participant-businessowner-expert category. Yes String
businessowners JSON array The IDs of the glossary value of participant-businessowner-expert category. Yes String
experts JSON array The IDs of the glossary value of participant-businessowner-expert category. Yes String
systems JSON array The IDs of the glossary value of system category. Yes String
dueDateType JSON body To set a due date duration, Set duration needs to be passed. Possible values are:
  • Set duration
  • No due date
Yes String
dueDateDuration JSON body The due date time value that is expressed with a number followed by a character unit marker. Yes String
cycleTime JSON body JSON object containing workTime and waitTime. Yes String
workTime JSON body The work time value that is expressed with a number followed by a character unit marker. Yes String
waitTime JSON body The wait time value that is expressed with a number followed by a character unit marker. Yes String
cost JSON body A number that represents the cost. Yes String
suppliers JSON array The IDs of the glossary value of supplier-customer category. Yes String
inputs JSON array The IDs of the glossary value of input-output category. Yes String
outputs JSON array The IDs of the glossary value of input-output category. Yes String
customers JSON array The IDs of the glossary value of supplier-customer category. Yes String
risk JSON body The amount of risk the activity introduces to the process. Possible values are:
  • Controlled
  • Low
  • Medium
  • High
 Yes String
valueAdd JSON body

Whether the activity adds value to the process. Possible values are:

  • Yes
  • No
  • Required
 Yes String
problems JSON array Array of Problem items. JSON array containing JSON objects of problem, severity, and frequency Yes String
problem JSON body

The ID of the glossary value of the problem category

 Yes String
severity JSON body

The severity of a problem. Possible values are:

  • Low
  • Medium
  • High
 Yes String
frequency JSON body

The frequency of a problem. Possible values are:

  • Low
  • Medium
  • High
 Yes String
activityPolicies JSON array The IDs of the policy item. Yes String
decisions JSON body The ID of the decision item. Yes String
name of your custom text property JSON array The IDs of the glossary value of your custom text property category. Yes String
name of your custom number property JSON body A number that represents the custom number property. Yes String
Character unit marker Description
m minutes
h hours
d days
w weeks
M months
Response
Example - Update Activity details

Update specific activity details

  • Using User Service ID OAuth 2 client credentials:
    curl -i --request PUT \
  --url https://your_server_url/bwl/blueprints/1c0003/activities/1c000b/details \
  --header 'authorization: Bearer access_token' \
  --header 'content-type: application/json' \
  --data '{"name": "Request Badge","participants": "4e0076","businessOwners": ["d002f","d003f","d0021"],"dueDateType": "set duration","dueDateDuration": "3M","cycleTime": {"workTime": "10d","waitTime": "1h"},"cost": "1000","risk": "controlled","valueAdd": "yes","problems": [{"problem": "d002e","severity": "medium","frequency": "high"}],"activityPolicies": ["ca000b","ca0022"],"decisions": "530053","custom text1": ["eb00cb","eb00cf"],"custom num 1": 3333}'
  • Using service ID OAuth 2 client credentials:
    curl -i --request PUT \
  --url https://your_server_url/bwl/blueprints/1c0003/activities/1c000b/details \
  --header 'authorization: Bearer access_token' \
  --header 'X-On-Behalf-Of: user_name@domain.com' \
  --header 'content-type: application/json' \
  --data '{"name": "Request Badge","participants": "4e0076","businessOwners": ["d002f","d003f","d0021"],"dueDateType": "set duration","dueDateDuration": "3M","cycleTime": {"workTime": "10d","waitTime": "1h"},"cost": "1000","risk": "controlled","valueAdd": "yes","problems": [{"problem": "d002e","severity": "medium","frequency": "high"}],"activityPolicies": ["ca000b","ca0022"],"decisions": "530053","custom text1": ["eb00cb","eb00cf"],"custom num 1": 3333}'
Example output

If the request is successful, a “200 OK” "Updated Activity Details" message is returned.

Response headers
Header name Description
Retry-After When the next request can be made, in a number of seconds.
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
This user didn't pass authentication. This response could appear for the following reasons:
  • An invalid username or password was provided.
  • This user belongs to multiple accounts and an account wasn't specified in the request.
403 Access is forbidden.
404 The blueprint-ID or activity-ID does not exist.
429 The request exceeded the rate limit of the API for this account.
More details
To get more details about the operations and response values, use a Swagger Editor to view the APIs:
  1. Download the rest-apis.zip file.
  2. Extract the openapi.yaml file.
  3. Open a web browser, and navigate to https://editor-next.swagger.io/.
  4. Import openapi.yaml using the File > Import File option.