Jump to

• Request
• Response
• Examples

Update one equipment instance association

patch

/fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}/child/WorkstationEquipmentInstance/{WsEquipmentInstanceId}

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.
• WsEquipmentInstanceId(required): 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.

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

• 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-WorkstationEquipmentInstance-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Date and time of the creation of the row.
• 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated with the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceDescription: string
  Title: Resource 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: Resource 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":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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":"Resource Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the production resource.",
            "nullable":true,
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login associated with the user who last updated the row.",
            "nullable":true,
            "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 : 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."
        }
    }
}

Links

WorkstationEquipmentInstanceLOV

The following properties are defined on the LOV link relation:

• Source Attribute: EquipmentInstanceId; Target Attribute: EquipmentInstanceId
• Display Attribute: EquipmentInstanceId

Back to Top

Examples

This example describes how to update one equipment instance association.

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/child/WorkstationEquipmentInstance/WsEquipmentInstanceId"

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/300100599122054/child/WorkstationEquipmentInstance/300100604774847"

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.

{
    "EquipmentInstanceId": "300100599120121"
}

Example Response Body

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

{
    "WsEquipmentInstanceId": 300100604774847,
    "EquipmentInstanceId": 300100599120121,
    "EquipmentInstanceCode": "MACHINE001",
    "EquipmentInstanceName": "Machine 001",
    "ResourceId": 300100071643725,
    "ResourceName": "MFGMACHINE-UnCosted",
    "ResourceDescription": "Assembly Machine-Un Costed",
    "WorkstationId": 300100599122054,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workstations/300100599122054/child/WorkstationEquipmentInstance/300100604774847",
            "name": "WorkstationEquipmentInstance",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/workstations/300100599122054/child/WorkstationEquipmentInstance/300100604774847",
            "name": "WorkstationEquipmentInstance",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/workstations/300100599122054",
            "name": "workstations",
            "kind": "item"
        }
    ]
}

Back to Top