Jump to

• Request
• Response
• Examples

Install an inventory

post

/rest/ofscCore/v1/resources/{resourceId}/inventories/{inventoryId}/custom-actions/install

This operation installs the specified inventory for the specified resource. The operation changes the inventory status to 'installed' and adds it to the 'installed' list of inventories for the specified activity.

If the inventory is associated with a segmentable activity, then the Activity ID must be specified.

Request

Path Parameters

• inventoryId(required): integer
  The unique identifier of the inventory in Oracle Field Service.
• resourceId(required): string
  The unique identifier of the resource to which the inventory is assigned or the activity (that has the inventory assigned to it) is assigned.

Body ()

Root Schema : Inventory Custom Action

Type: object

Title: Inventory Custom Action

The schema of the request body object for this operation.

Show Source

• activityId: integer
  Title: Activity ID

  The unique identifier of the activity in Oracle Field Service.
• quantity: number
  Title: Quantity of Inventory

  The quantity of the inventory.

{
    "title":"Inventory Custom Action",
    "description":"The schema of the request body object for this operation.",
    "properties":{
        "activityId":{
            "type":"integer",
            "description":"The unique identifier of the activity in Oracle Field Service.",
            "title":"Activity ID"
        },
        "quantity":{
            "type":"number",
            "description":"The quantity of the inventory.",
            "title":"Quantity of Inventory"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Error response

Show Source

• detail: string
  The detailed information about the error.
• status: string
  The HTTP status code.
• title: string
  The summary of the error message.
• type: string
  The URL of the page containing the error details.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the page containing the error details."
        },
        "title":{
            "type":"string",
            "description":"The summary of the error message."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code."
        },
        "detail":{
            "type":"string",
            "description":"The detailed information about the error."
        }
    },
    "description":"Error response"
}

Back to Top

Examples

The following example shows how to install a inventory for a resource by submitting a POST request on the REST resource.

Example of Request Header

The following shows an example of the request header.

POST /rest/ofscCore/v1/resources/44035/inventories/21258547/custom-actions/install HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: <instance_name>.fs.ocs.oraclecloud.com
Accept: */*

Example of Request Body

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

 
{
        "quantity": "30",
        "activityId": "4225279"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Fri, 24 Jul 2015 08:35:48 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.

{
            "inventoryId": 21258547,
            "status": "install",
            "inventoryType": "EC",
            "serialNumber": "werwerwerwe",
            "quantity": 30,
            "resourceId": "44011",
            "activityId": 21258547,
            "links": [
                {
                  "rel": "canonical",
                  "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/inventories/21258547"
                },
                {
                  "rel": "describedby",
                  "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/metadata-catalog/inventories"
                }
            ]
 }

Back to Top