Jump to

• Request
• Response

Start routing plan

post

/rest/ofscMetadata/v1/routingProfiles/{profileLabel}/plans/{planLabel}/{resourceExternalId}/{date}/custom-actions/start

This operation starts the routing plan.

Request

Path Parameters

• date(required): string
  Minimum Length: 1

  Maximum Length: 32

  Date to start routing profile for. Specify the date in YYYY-MM-DD format.
• planLabel(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the routing plan.
• profileLabel(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the routing profile.
• resourceExternalId(required): string
  Minimum Length: 1

  Maximum Length: 32

  The external ID of the bucket.

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Error response

Show Source

• detail: string
  The detailed information about the error.
• status: string
  The HTTP status code.
• title: string
  The summary of the error message.
• type: string
  The URL of the page containing the error details.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the page containing the error details."
        },
        "title":{
            "type":"string",
            "description":"The summary of the error message."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code."
        },
        "detail":{
            "type":"string",
            "description":"The detailed information about the error."
        }
    },
    "description":"Error response"
}

Back to Top