Jump to

• Request
• Response

Get buckets associated with routing profile

get

/api/field-service/routing/v1/routingProfiles/{profileLabel}/buckets

This operation retrieves the list of buckets associated with the specified routing profile label.

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. If no value is specified, then it defaults to 10.
• 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/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : routingProfileBuckets

Type: object

A collection of buckets assigned to the routing profile.

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 resource objects representing the buckets.
• 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 10.
• offset: integer
  The offset value specified in the request.
• totalResults: integer
  The total number of bucket records in the collection.

{
    "description":"A collection of buckets assigned to the routing profile.",
    "properties":{
        "items":{
            "type":"array",
            "description":"An array of resource objects representing the buckets.",
            "items":{
                "type":"object",
                "properties":{
                    "resourceExternalId":{
                        "type":"string",
                        "description":"The external identifier of the resource (bucket)."
                    },
                    "resourceName":{
                        "type":"string",
                        "description":"The display name of the resource."
                    },
                    "schedulingProfileId":{
                        "type":"integer",
                        "description":"The ID of the routing profile this bucket is associated with."
                    }
                }
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of bucket 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 10."
        }
    }
}

Nested Schema : items

Type: array

An array of resource objects representing the buckets.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"An array of resource objects representing the buckets.",
    "items":{
        "type":"object",
        "properties":{
            "resourceExternalId":{
                "type":"string",
                "description":"The external identifier of the resource (bucket)."
            },
            "resourceName":{
                "type":"string",
                "description":"The display name of the resource."
            },
            "schedulingProfileId":{
                "type":"integer",
                "description":"The ID of the routing profile this bucket is associated with."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• resourceExternalId: string
  The external identifier of the resource (bucket).
• resourceName: string
  The display name of the resource.
• schedulingProfileId: integer
  The ID of the routing profile this bucket is associated with.

{
    "type":"object",
    "properties":{
        "resourceExternalId":{
            "type":"string",
            "description":"The external identifier of the resource (bucket)."
        },
        "resourceName":{
            "type":"string",
            "description":"The display name of the resource."
        },
        "schedulingProfileId":{
            "type":"integer",
            "description":"The ID of the routing profile this bucket is associated with."
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(required): string
  The detailed description of this error.
• status(required): 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",
        "status",
        "detail"
    ]
}

Back to Top