Jump to

• Request
• Response
• Examples

Update one workstation

patch

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

Request

Path Parameters

• WorkstationId(required): integer(int64)
  Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• WorkCenterId: integer (int64)
  Title: Work Center

  Value that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center.
• WorkstationCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the workstation.
• WorkstationDescription: string
  Title: Description

  Maximum Length: 240

  Description of the workstation.
• WorkstationEquipmentInstance: array Workstation Equipment Instances
  Title: Workstation Equipment Instances

  Equipment resource instances associated with the workstation.
• WorkstationId: integer (int64)
  Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
• WorkstationName: string
  Title: Name

  Maximum Length: 120

  Name of the workstation.

{
    "type":"object",
    "properties":{
        "WorkstationDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the workstation.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkstationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the workstation.",
            "nullable":false
        },
        "WorkstationEquipmentInstance":{
            "title":"Workstation Equipment Instances",
            "type":"array",
            "description":"Equipment resource instances associated with the workstation.",
            "items":{
                "$ref":"#/components/schemas/workstations-WorkstationEquipmentInstance-item-patch-request"
            }
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "WorkstationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the workstation.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        }
    }
}

Nested Schema : Workstation Equipment Instances

Type: array

Title: Workstation Equipment Instances

Equipment resource instances associated with the workstation.

Show Source

• Array of: object schema

{
    "title":"Workstation Equipment Instances",
    "type":"array",
    "description":"Equipment resource instances associated with the workstation.",
    "items":{
        "$ref":"#/components/schemas/workstations-WorkstationEquipmentInstance-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment instance that is associated with this workstation.
• WorkstationId: integer (int64)
  Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.

{
    "type":"object",
    "properties":{
        "EquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment instance that is associated with this workstation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : workstations-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization.
• WorkCenterCode: string
  Title: Work Center Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the parent work center.
• WorkCenterDescription: string
  Title: Work Center Description

  Read Only: true

  Maximum Length: 240

  Description of the parent work center.
• WorkCenterId: integer (int64)
  Title: Work Center

  Value that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center.
• WorkCenterName: string
  Title: Work Center

  Read Only: true

  Maximum Length: 120

  Name of the parent work center.
• WorkstationCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the workstation.
• WorkstationDescription: string
  Title: Description

  Maximum Length: 240

  Description of the workstation.
• WorkstationEquipmentInstance: array Workstation Equipment Instances
  Title: Workstation Equipment Instances

  Equipment resource instances associated with the workstation.
• WorkstationId: integer (int64)
  Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
• WorkstationName: string
  Title: Name

  Maximum Length: 120

  Name of the workstation.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Work Center",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the parent work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkstationDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the workstation.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Work Center Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the parent work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkstationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the workstation.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkstationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the workstation.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "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"
            }
        },
        "WorkstationEquipmentInstance":{
            "title":"Workstation Equipment Instances",
            "type":"array",
            "description":"Equipment resource instances associated with the workstation.",
            "items":{
                "$ref":"#/components/schemas/workstations-WorkstationEquipmentInstance-item-response"
            }
        },
        "WorkCenterCode":{
            "title":"Work Center Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the parent work center.",
            "nullable":false,
            "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 : Workstation Equipment Instances

Type: array

Title: Workstation Equipment Instances

Equipment resource instances associated with the workstation.

Show Source

• Array of: object workstations-WorkstationEquipmentInstance-item-response

{
    "title":"Workstation Equipment Instances",
    "type":"array",
    "description":"Equipment resource instances associated with the workstation.",
    "items":{
        "$ref":"#/components/schemas/workstations-WorkstationEquipmentInstance-item-response"
    }
}

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 : workstations-WorkstationEquipmentInstance-item-response

Type: object

Show Source

• EquipmentInstanceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the equipment instance that is associated with this workstation.
• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment instance that is associated with this workstation.
• EquipmentInstanceName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the equipment instance that is associated with this workstation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the production resource.
• ResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the production resource.
• WorkstationId: integer (int64)
  Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
• WsEquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment instance associated with workstation. It's a primary key that the application generates when it creates an equipment instance association with a workstation. This attribute is required.

{
    "type":"object",
    "properties":{
        "WsEquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment instance associated with workstation. It's a primary key that the application generates when it creates an equipment instance association with a workstation. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EquipmentInstanceCode":{
            "title":"Code",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the equipment instance that is associated with this workstation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the production resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkstationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EquipmentInstanceName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the equipment instance that is associated with this workstation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment instance that is associated with this workstation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "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

WorkstationEquipmentInstance

Operation: /fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}/child/WorkstationEquipmentInstance

Parameters:

• WorkstationId: $request.path.WorkstationId

Equipment resource instances associated with the workstation.

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