RoutesResource

The following resources are part of this group:

/routes

GET

Gets the routes.

Parameters

name description type default
limit the limit count to get. query
offset the offset from the first one. query 0
type the route type to sort by. query
businessUnit the business unit to filter for. query
account the account to filter for. query
subscription the route package template subscription id. query
referredByRoute which route is referred by this route. query
name the route name. query
fields comma separated string of route properties to return query
currentSubscription (no documentation provided) query
version (no documentation provided) path

Response Body

element: routes

the routes

POST

Creates a route. It is possible to create three types of Route:

  • Template Route:
    - the property type is to be TEMPLATE
    - it can have businessUnits property which is a list of business unit names appropriate for the Administrator who is creating this route
    - it may not have account property
    - it may not have subscriptions property
    - it may not have routeTemplate property
  • Composite Route:
    - the property type is to be COMPOSITE
    - it is to have routeTemplate property pointing to the id of an existing Template Route visible by the account this route is created for
    - it can have account property which is the name of an existing account
    - it can have subscriptions property which is a list of subscription id-s which belongs to the account this route is created for
    - it may not have businessUnits property
  • Simple Route:
    - the property type is to be SIMPLE
    - it may not have businessUnits property
    - it may not have account property
    - it may not have subscriptions property
    - it may not have routeTemplate property
    • The route to be created may not have steps property. Steps are managed by the routes' sub-resource steps.

    Parameters

    name description type default
    version (no documentation provided) path

    Request Body

    element: route

    the route to create

    Response Body

    element: (custom)

    a response with location header and info entity as a result in case of success

    /routes/count

    GET

    Gets the number of route entries found on the specified criteria.

    Parameters

    name description type default
    type the route type to sort by. query
    version (no documentation provided) path

    Response Body

    element: collectionCount

    the count of route entries.

    /routes/{routeId}

    The following operations are supported on this resource:

    GET

    Gets a single route.

    Parameters

    name description type default
    routeId the public route id path
    version (no documentation provided) path

    Response Body

    element: route

    the route

    POST

    Updates route properties. The type property cannot be changed. The following restrictions will be applied as well:

  • Template Route:
    - it can have businessUnits property which is a list of business unit names appropriate for the Administrator who is creating this route
    - it may not have account property
    - it may not have subscriptions property
    - it may not have routeTemplate property
  • Composite Route:
    - it is to have routeTemplate property pointing to the id of an existing Template Route visible by the account this route is created for
    - it can have account property which is the name of an existing account
    - it can have subscriptions property which is a list of subscription id-s which belongs to the account this route is created for
    - it may not have businessUnits property
  • Simple Route:
    - it may not have routeTemplate property
    - it may not have businessUnits property
    - it may not have account property
    - it may not have subscriptions property
    • The route to be updated may not have steps property. Steps are managed by the routes' sub-resource steps.

    Parameters

    name description type default
    routeId the route id. path
    version (no documentation provided) path

    Request Body

    element: route

    the route to update.

    DELETE

    Deletes a route.

    Parameters

    name description type default
    routeId - the route public identifier path
    version (no documentation provided) path

    /routes/{routeId}/inheritedSteps

    GET

    Gets the inherited route step statuses.

    Parameters

    name description type default
    routeId the ID of route package about to get inherited steps for; specified as a path parameter path
    limit the limit count to get; specified as a query parameter query
    offset the offset from the first one; specified as a query parameter query 0
    version (no documentation provided) path

    Response Body

    element: routeStepStatuses

    the inherited route step statuses

    PUT

    Overwrites route step statuses belonging to a route package. This method expects to put inherited steps which status is allowed to be modified (that is the steps which status is enabled in related route package template).

    Parameters

    name description type default
    routeId the id of the route package which step statuses will be overwritten. path
    version (no documentation provided) path

    Request Body

    element: routeStepStatuses

    the route step statuses to update.

    Response Body

    element: (custom)

    a response containing as entity RouteStepStatuses of statuses updated

    /routes/{routeId}/steps

    The following operations are supported on this resource:

    POST

    Creates a route step. The properties of a step are:

  • type Specifies step type. Mandatory property. Depending on the value of that property it can be specified custom properties.
  • conditionType Specifies the type of the condition property fulfilling of which will trigger execution of the step. Mandatory property. Possible values are ALWAYS_EXECUTE and EL.
  • condition Specifies the condition fulfilling of which will trigger execution of the step. This property is mandatory if the value of conditionType is EL in which case takes values as a JUEL expression.
  • status Specifies step status. Mandatory property. Possible values are ENABLED and DISABLED.
  • autostart Specifies if the step is to be auto-startable. It is allowed to take false value only at present.
  • executeRoute Specifies the id of a Simple route. This property can be set only if type is set to ExecuteRoute. Steps with type set to ExecuteRoute can be created for routes of type TEMPLATE or COMPOSITE.
  • precedingStep Specifies the id of the step preceding the step to be created. If this property is not set explicitly, it will be set to the last step belonging to same route. If the step to be created is the first one, the value of this property will be null.
  • A set of custom properties specific for each step depending on step type.

    • Parameters

    name description type default
    routeId the ID of route to which the step to be created will belong to; specified as a path parameter path
    version (no documentation provided) path

    Request Body

    element: step

    the route step to create

    Response Body

    element: (custom)

    a response object containing as an entity the step created

    GET

    Gets the route steps.

    Parameters

    name description type default
    routeId the ID of route about to get steps for; specified as a path parameter path
    limit the limit count to get; specified as a query parameter query
    offset the offset from the first one; specified as a query parameter query 0
    version (no documentation provided) path

    Response Body

    element: routeSteps

    the route steps

    PUT

    Overwrites route steps belonging to a route. Route steps id-s are preserved. Existing route steps, which are not supplied in routeSteps, are deleted. New steps are saved.

    Parameters

    name description type default
    routeId the id of the route which steps will be overwritten. path
    version (no documentation provided) path

    Request Body

    element: routeSteps

    the route steps to overwrite.

    Response Body

    element: (custom)

    a response containing as entity steps overwritten

    /routes/{routeId}/inheritedSteps/{routeStepId}

    GET

    Gets a inherited route step status.

    Parameters

    name description type default
    routeId the ID of route package about to get inherited steps for; specified as a path parameter path
    routeStepId the id of an inherited route step; specified as a path parameter. path
    version (no documentation provided) path

    Response Body

    element: stepStatus

    the inherited route step status

    POST

    Updates status of an inherited route step. A step is inherited for a route package if it belongs to the route package template from which the route package is derived from. Modified status concerns the route package only.

    Parameters

    name description type default
    routeId the id of a route package. path
    routeStepId the id of an inherited route step. path
    version (no documentation provided) path

    Request Body

    element: stepStatus

    the route step status to update.

    /routes/{routeId}/steps/{routeStepId}

    The following operations are supported on this resource:

    GET

    Gets a route step.

    Parameters

    name description type default
    routeId the ID of route about to get a step; specified as a path parameter path
    routeStepId the ID of route step to get; specified as a path parameter path
    version (no documentation provided) path

    Response Body

    element: step

    the route step

    POST

    Updates properties of a route step.

    Parameters

    name description type default
    routeId the route id. path
    routeStepId the route step id. path
    version (no documentation provided) path

    Request Body

    element: step

    the route step to update.

    DELETE

    Deletes a route step.

    Parameters

    name description type default
    routeId - the route public identifier path
    routeStepId - the route step identifier path
    version (no documentation provided) path