Update one workstation

patch

/fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments that are associated with workstations.
Show Source
Nested Schema : Workstation Equipment Instances
Type: array
Title: Workstation Equipment Instances
Equipment resource instances associated with the workstation.
Show Source
Nested Schema : workstations-Attachments-item-patch-request
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
A preview of workstation attachments.
Show Source
Nested Schema : workstations-Attachments-AttachmentsPreview-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : workstations-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments that are associated with workstations.
Show Source
Nested Schema : Workstation Equipment Instances
Type: array
Title: Workstation Equipment Instances
Equipment resource instances associated with the workstation.
Show Source
Nested Schema : workstations-Attachments-item-response
Type: object
Show Source
Nested Schema : Attachment Previews
Type: array
Title: Attachment Previews
A preview of workstation attachments.
Show Source
Nested Schema : workstations-Attachments-AttachmentsPreview-item-response
Type: object
Show Source
Nested Schema : workstations-WorkstationEquipmentInstance-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to update one workstation.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workstations/WorkstationId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workstations/300100545640760"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "WorkstationDescription": "Spray Paint WorkStation - A"
}

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "OrganizationId": 204,
    "OrganizationCode": "V1",
    "OrganizationName" : "Vision Operations",
    "WorkstationId": 300100545640760,
    "WorkStationCode": "SPRAY_WORKSTATION_A",
    "WorkStationName": "Spray Paint WorkStation A",
    "WorkStationDescription": "Spray Paint WorkStation - A",
    "WorkCenterId": 300100071642891,
    "WorkCenterCode": "PAINT_WA",
    "WorkCenterName": "SPRAY_WC",
    "WorkCenterDescription": "Paint",
    "links": [
    {
        "rel": "self",
        "href": "https://servername/fscmRestApi/resources/version/workstations/300100545640760"
        ...
    }
    ]
}
Back to Top