Jump to

• Request
• Response

Get a capacity category

get

/crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}

Request

Path Parameters

• Id(required): integer
  The unique identifier of the capacity category.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : svcWoCapacities-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type Code

  Read Only: true

  The identifier of the activity type. It is used to define the duration, travel time, capacity category, and work zone.
• Capacity: array Capacities
  Title: Capacities

  The capacities resource is used to view capacities used in Oracle Field Service Cloud.
• EndDate: string
  Read Only: true

  The end date for the capacity.
• ErrorCode: string
  Read Only: true

  The error code returned when you try to get a capacity.
• ErrorMessage: string
  Read Only: true

  The error message returned when you try to get a capacity.
• Id: integer
  Read Only: true

  The unique identifier of the capacity category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  The post code associated with the capacity category.
• StartDate: string
  Read Only: true

  The start time of the time slot associated with the capacity.
• TimeSlotInfo: array Time Slots
  Title: Time Slots

  The time slots resource is used to view all times slots used in Oracle Field Service Cloud.
• TimeZone: string
  Read Only: true

  The time zone associated with the capacity.
• WoAreaKey: string
  Title: Work Order Area Key

  Read Only: true

  The work order area key associated with the capacity category.
• WorkOrderArea: string
  Title: Work Order Area

  Read Only: true

  Maximum Length: 256

  The unique external identifier of the capacity category.

{
    "type":"object",
    "properties":{
        "WorkOrderArea":{
            "title":"Work Order Area",
            "maxLength":"256",
            "type":"string",
            "description":"The unique external identifier of the capacity category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoAreaKey":{
            "title":"Work Order Area Key",
            "type":"string",
            "description":"The work order area key associated with the capacity category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "type":"string",
            "description":"The identifier of the activity type. It is used to define the duration, travel time, capacity category, and work zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "type":"string",
            "description":"The post code associated with the capacity category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date for the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start time of the time slot associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeZone":{
            "type":"string",
            "description":"The time zone associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Capacity":{
            "title":"Capacities",
            "type":"array",
            "description":"The capacities resource is used to view capacities used in Oracle Field Service Cloud.",
            "items":{
                "$ref":"#/components/schemas/svcWoCapacities-Capacity-item-response"
            }
        },
        "TimeSlotInfo":{
            "title":"Time Slots",
            "type":"array",
            "description":"The time slots resource  is used to view all times slots used in Oracle Field Service Cloud.",
            "items":{
                "$ref":"#/components/schemas/svcWoCapacities-TimeSlotInfo-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the capacity category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorCode":{
            "type":"string",
            "description":"The error code returned when you try to get a capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "type":"string",
            "description":"The error message returned when you try to get a capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Capacities

Type: array

Title: Capacities

The capacities resource is used to view capacities used in Oracle Field Service Cloud.

Show Source

• Array of: object svcWoCapacities-Capacity-item-response

{
    "title":"Capacities",
    "type":"array",
    "description":"The capacities resource is used to view capacities used in Oracle Field Service Cloud.",
    "items":{
        "$ref":"#/components/schemas/svcWoCapacities-Capacity-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Time Slots

Type: array

Title: Time Slots

The time slots resource is used to view all times slots used in Oracle Field Service Cloud.

Show Source

• Array of: object svcWoCapacities-TimeSlotInfo-item-response

{
    "title":"Time Slots",
    "type":"array",
    "description":"The time slots resource  is used to view all times slots used in Oracle Field Service Cloud.",
    "items":{
        "$ref":"#/components/schemas/svcWoCapacities-TimeSlotInfo-item-response"
    }
}

Nested Schema : svcWoCapacities-Capacity-item-response

Type: object

Show Source

• Available: integer
  Read Only: true

  The number of man-minutes available in the Oracle Field Service Cloud resource bucket for the specified date, time slot, and capacity category excluding the minutes already reserved for the same date, time slot, and capacity category in the same capacity bucket.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quota: integer
  Read Only: true

  The total number of man-minutes available in the Oracle Field Service Cloud resource bucket for the specified date, time slot, and capacity category.
• TimeSlot: string
  Read Only: true

  The time slot for which capacity quota and available capacity in Oracle Field Service Cloud is returned.
• TimeSlotDate: string
  Read Only: true

  Maximum Length: 255

  The date for which capacity quota and available capacity in Oracle Field Service Cloud is returned.
• WorkOrderArea: string
  Read Only: true

  Maximum Length: 256

  The name of the work order area associated with the capacity.
• WorkSkill: string
  Read Only: true

  The work skill label associated with the capacity.

{
    "type":"object",
    "properties":{
        "WorkOrderArea":{
            "maxLength":"256",
            "type":"string",
            "description":"The name of the work order area associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quota":{
            "type":"integer",
            "description":"The total number of man-minutes available in the Oracle Field Service Cloud resource bucket for the specified date, time slot, and capacity category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkSkill":{
            "type":"string",
            "description":"The work skill label associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeSlotDate":{
            "maxLength":"255",
            "type":"string",
            "description":"The date for which capacity quota and available capacity in Oracle Field Service Cloud is returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Available":{
            "type":"integer",
            "description":"The number of man-minutes available in the Oracle Field Service Cloud resource bucket for the specified date, time slot, and capacity category excluding the minutes already reserved for the same date, time slot, and capacity category in the same capacity bucket.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeSlot":{
            "type":"string",
            "description":"The time slot for which capacity quota and available capacity in Oracle Field Service Cloud is returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : svcWoCapacities-TimeSlotInfo-item-response

Type: object

Show Source

• Label: string
  Read Only: true

  Maximum Length: 255

  The label for the time slot associated with the capacity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  The name of the time slot associated with the capacity.
• TimeFrom: string
  Read Only: true

  The start time of the time slot associated with the capacity.
• TimeTo: string
  Read Only: true

  The end time of the time slot associated with the capacity.

{
    "type":"object",
    "properties":{
        "Label":{
            "maxLength":"255",
            "type":"string",
            "description":"The label for the time slot associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeTo":{
            "type":"string",
            "description":"The end time of the time slot associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TimeFrom":{
            "type":"string",
            "description":"The start time of the time slot associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the time slot associated with the capacity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

Capacity

Operation: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/Capacity

Parameters:

• Id: $request.path.Id

The capacities resource is used to view capacities used in Oracle Field Service Cloud.

TimeSlotInfo

Operation: /crmRestApi/resources/11.13.18.05/svcWoCapacities/{Id}/child/TimeSlotInfo

Parameters:

• Id: $request.path.Id

The time slots resource is used to view all times slots used in Oracle Field Service Cloud.

Back to Top