Jump to

• Request
• Response
• Examples

Deinstall an inventory

post

/rest/ofscCore/v1/inventories/{inventoryId}/custom-actions/deinstall

This operation deinstalls the specified inventory.

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

Request

Path Parameters

• inventoryId(required): integer
  The unique identifier of an inventory in Oracle Field Service.

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

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 uninstall inventory 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/inventories/21258547/custom-actions/deinstall HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: etadev1f
Accept: */*

Example of Request Body

The following shows an example of the request body.

{
  "quantity": "30"
}

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
ContentType:
application/json; charset=utf8
Connection: close

Example of Response Body

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

{
"inventoryId": 21258547,
"status": "deinstall",
"inventoryType": "EC",
"quantity": 30,
"resourceId": "44011",
"activityId": 21258547,
"links": [
{
"rel": "canonical",
"href": "https://etadev1f/rest/ofscCore/v1/inventories/21258547"
},
{
"rel": "describedby",
"href": "https://etadev1f/rest/ofscCore/v1/metadatacatalog/inventories"
}
]
}

Back to Top