Jump to

• Request
• Response
• Examples

Get required inventories of an activity

get

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

This operation retrieves the required inventories of the specified activity.

Request

Path Parameters

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

Query Parameters

• limit: integer
  The number of items to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified 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 record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Required Inventories of Activity

Type: object

Title: Required Inventories of Activity

The schema of the request body object for this operation.

Show Source

• items: array Items
  Title: Items

  The collection of required inventories for the specified activity.

{
    "type":"object",
    "title":"Required Inventories of Activity",
    "description":"The schema of the request body object for this operation.",
    "properties":{
        "items":{
            "items":{
                "$ref":"#/definitions/requiredInventory"
            },
            "type":"array",
            "description":"The collection of required inventories for the specified activity.",
            "title":"Items"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of required inventories for the specified activity.

Show Source

• Array of: object Required Inventory
  Title: Required Inventory

  The array of required inventory item objects assigned to the specified activity.

{
    "items":{
        "$ref":"#/definitions/requiredInventory"
    },
    "type":"array",
    "description":"The collection of required inventories for the specified activity.",
    "title":"Items"
}

Nested Schema : Required Inventory

Type: object

Title: Required Inventory

The array of required inventory item objects assigned to the specified activity.

Show Source

• inventoryType(required): string
  Title: Required Inventory Type

  The required inventory type for the specified activity.
• model(required): string
  Title: Required Inventory Model

  The required inventory model for the specified activity.
• quantity(required): number
  Title: Required Inventory Quantity

  The required quantity of inventory for the specified activity.

{
    "type":"object",
    "required":[
        "inventoryType",
        "model",
        "quantity"
    ],
    "description":"The array of required inventory item objects assigned to the specified activity.",
    "properties":{
        "quantity":{
            "type":"number",
            "description":"The required quantity of inventory for the specified activity.",
            "title":"Required Inventory Quantity"
        },
        "inventoryType":{
            "type":"string",
            "description":"The required inventory type for the specified activity.",
            "title":"Required Inventory Type"
        },
        "model":{
            "type":"string",
            "description":"The required inventory model for the specified activity.",
            "title":"Required Inventory Model"
        }
    },
    "title":"Required Inventory"
}

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

Examples

The following example shows how to get the required inventories of an activity by submitting a GET request on the REST resource using cURL.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \
     -H 'Accept: application/json' \
     'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/activities/4225269/requiredInventories'

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.2.7
Date: Fri, 18 Mar 2016 02:20:09 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [

    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/activities/4225269/requiredInventories"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore//v1/metadata-catalog/activities#definitions/requiredInventories"
        }
    ]
}

Back to Top