Skip to content

Create an activity

Request

Creates an activity.

Security
Bearer
Bodyapplication/jsonrequired
namestring, [ 1 .. 64 ] characters^[a-zA-Z0-9_]*$required

Name of the activity. It must start with 'custom'.

Example:"custom_get_quote_v1"
context_namestring, [ 1 .. 32 ] characters^[a-zA-Z0-9_]*$required

Context name used for accessing request/response of activities.

Example:"get_quote"
bean_namestring, [ 1 .. 32 ] characters^[a-zA-Z0-9]*$required

Bean name used for activity execution.

Example:"getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Default:false
Example:false
notification_typestring, [ 1 .. 128 ] characters^[a-zA-Z0-9_:]*$required

notification_type used for validating messages in queue when activity in execution.

activity_descriptionstring, [ 1 .. 256 ] characters^[a-zA-Z0-9@_,.:\s-]*$required

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/activity \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "custom_get_quote_v1",
    "context_name": "get_quote",
    "bean_name": "getQuoteV1",
    "end_activity": false,
    "notification_type": "string",
    "activity_description": "string",
    "retry_interval": 0
  }'

Responses

Successfully created activity.

Bodyapplication/json
uuidstring, (uuid)

Unique Identifier of the activity.

Example:"5492648d-2132-4e70-9ded-2fc86f22b321"
namestring

Activity name.

Example:"get_quote_v1"
context_namestring

Context name used for accessing request/response of activities.

Example:"get_quote"
bean_namestring

Bean name used for activity execution.

Example:"getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Example:false
activity_descriptionstring, <= 256 characters

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

created_atstring, (date-time)

Date and time at which the activity was created, as an ISO-8601 timestamp in UTC.

Example:"2018-04-06T20:33:35Z"
Response
{
  "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "name": "get_quote_v1",
  "context_name": "get_quote",
  "bean_name": "getQuoteV1",
  "end_activity": false,
  "activity_description": "string",
  "retry_interval": 0,
  "created_at": "2018-04-06T20:33:35Z"
}