Jump to

• Request
• Response

Get routing plans labels

get

/rest/ofscMetadata/v1/routingProfiles/{profileLabel}/plans

This operation retrieves the list of routing plan labels for a routing profile.

Request

Path Parameters

• profileLabel(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the routing profile.

Query Parameters

• limit: integer
  The maximum number of items returned in the response. The minimum value is 1 and the maximum value is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
• offset: integer
  The number of items that are skipped in the response. If a value is not specified, then it defaults to zero. The value zero indicates that the retrieval starts from the beginning of the collection.

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : routingPlanLabels

Type: object

The collection of routing plan labels.

Show Source

• hasMore: boolean
  Contains one of the following values: true or false. The default value is true.

  True indicates there are more results that can be retrieved with successive paging requests. False or the value is not present, indicates, there are no more results or this is the final page.

• items: array items
  An array of routing plan labels.
• limit: integer
  The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
• offset: integer
  The offset value specified in the request.
• totalResults: integer
  The total number of the resource type records in the collection.

{
    "description":"The collection of routing plan labels.",
    "properties":{
        "items":{
            "type":"array",
            "description":"An array of routing plan labels.",
            "items":{
                "title":"Routing Plan Label",
                "type":"string",
                "minLength":"1",
                "maxLength":"40"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of the resource type records in the collection. "
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. The default value is true.<p>True indicates there are more results that can be retrieved with successive paging requests. False or the value is not present, indicates, there are no more results or this is the final page.</p>"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100."
        }
    }
}

Nested Schema : items

Type: array

An array of routing plan labels.

Show Source

• Array of: string
  Title: Routing Plan Label

  Minimum Length: 1

  Maximum Length: 40

{
    "type":"array",
    "description":"An array of routing plan labels.",
    "items":{
        "title":"Routing Plan Label",
        "type":"string",
        "minLength":"1",
        "maxLength":"40"
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top