Jump to

• Request
• Response

Get capacity categories of activity

get

/rest/ofscCore/v1/activities/{activityId}/capacityCategories

This operation returns capacity categories of the specified activity.

Request

Path Parameters

• activityId(required): integer
  The unique identifier of the activity in Oracle Field Service.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Capacity categories

Type: object

Title: Capacity categories

The collection of capacity categories. It is not returned for an empty collection.

Show Source

• items: array Items
  Title: Items

  The collection of capacity categories.
• totalResults: integer
  Title: Total Results

  The total number of capacity categories records in the collection.

{
    "type":"object",
    "title":"Capacity categories",
    "description":"The collection of capacity categories. It is not returned for an empty collection.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActivityCapacityCategory"
            },
            "title":"Items",
            "description":"The collection of capacity categories."
        },
        "totalResults":{
            "type":"integer",
            "title":"Total Results",
            "description":"The total number of capacity categories records in the collection. "
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of capacity categories.

Show Source

• Array of: object Capacity category
  Title: Capacity category

  The capacity category of activity.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ActivityCapacityCategory"
    },
    "title":"Items",
    "description":"The collection of capacity categories."
}

Nested Schema : Capacity category

Type: object

Title: Capacity category

The capacity category of activity.

Show Source

• capacityCategory: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the capacity category.

{
    "type":"object",
    "title":"Capacity category",
    "description":"The capacity category of activity.",
    "properties":{
        "capacityCategory":{
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Label",
            "description":"The label of the capacity category."
        }
    }
}

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