Jump to

• Request
• Response
• Examples

Update one instance

patch

/fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/EquipmentInstance/{EquipmentInstanceId}

Request

Path Parameters

• EquipmentInstanceId(required): integer(int64)
  Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
• ResourceId(required): integer(int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.

Header Parameters

• Metadata-Context: string
  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: string
  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

• AssetId: integer (int64)
  Title: Asset Number

  Value that uniquely identifies the item associated with the asset in the maintenance organization.
• AssetNumber: string
  Maximum Length: 80

  Unique asset number that identifies the equipment instance.
• EquipmentIdentifier: string
  Title: Identifier

  Maximum Length: 80

  Abbreviation that identifies the equipment resource instance.
• EquipmentInstanceDFF: array Flexfields for Equipment Instances
  Title: Flexfields for Equipment Instances

  The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.
• EquipmentInstanceName: string
  Title: Name

  Maximum Length: 120

  Name of the equipment resource instance.
• InactiveDate: string (date)
  Title: Inactive On

  Date when the equipment instance becomes inactive.
• PrimaryWorkCenterCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the primary work center.
• PrimaryWorkCenterId: integer (int64)
  Title: Primary Work Center

  Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center that the application assigns to this equipment instance.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "title":"Asset Number",
            "type":"integer",
            "description":"Value that uniquely identifies the item associated with the asset in the maintenance organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AssetNumber"
                ]
            }
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Unique asset number that identifies the equipment instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EquipmentIdentifier":{
            "title":"Identifier",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the equipment resource instance.",
            "nullable":false
        },
        "EquipmentInstanceDFF":{
            "title":"Flexfields for Equipment Instances",
            "type":"array",
            "description":"The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.",
            "items":{
                "$ref":"#/components/schemas/productionResources-EquipmentInstance-EquipmentInstanceDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "EquipmentInstanceName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the equipment resource instance.",
            "nullable":false
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the equipment instance becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "PrimaryWorkCenterCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the primary work center.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryWorkCenterId":{
            "title":"Primary Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center that the application assigns to this equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PrimaryWorkCenterCode"
                ]
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Flexfields for Equipment Instances

Type: array

Title: Flexfields for Equipment Instances

The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.

Show Source

• Array of: object schema

{
    "title":"Flexfields for Equipment Instances",
    "type":"array",
    "description":"The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.",
    "items":{
        "$ref":"#/components/schemas/productionResources-EquipmentInstance-EquipmentInstanceDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for equipment instances.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for equipment instances.

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for equipment instances.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for equipment instances.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : productionResources-EquipmentInstance-item-response

Type: object

Show Source

• AssetDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the asset that identifies the equipment instance.
• AssetId: integer (int64)
  Title: Asset Number

  Value that uniquely identifies the item associated with the asset in the maintenance organization.
• AssetItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the asset in the maintenance organization.
• AssetItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item associated with the asset in the maintenance organization.
• AssetItemNumber: string
  Read Only: true

  Maximum Length: 300

  Item number of the asset that identifies the equipment instance.
• AssetNumber: string
  Maximum Length: 80

  Unique asset number that identifies the equipment instance.
• EquipmentIdentifier: string
  Title: Identifier

  Maximum Length: 80

  Abbreviation that identifies the equipment resource instance.
• EquipmentInstanceDFF: array Flexfields for Equipment Instances
  Title: Flexfields for Equipment Instances

  The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.
• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
• EquipmentInstanceName: string
  Title: Name

  Maximum Length: 120

  Name of the equipment resource instance.
• InactiveDate: string (date)
  Title: Inactive On

  Date when the equipment instance becomes inactive.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
• PrimaryWorkCenterCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the primary work center.
• PrimaryWorkCenterId: integer (int64)
  Title: Primary Work Center

  Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center that the application assigns to this equipment instance.
• PrimaryWorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Abbreviation that identifies the name of the primary work center.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.

{
    "type":"object",
    "properties":{
        "AssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the asset that identifies the equipment instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset Number",
            "type":"integer",
            "description":"Value that uniquely identifies the item associated with the asset in the maintenance organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AssetNumber"
                ]
            },
            "x-queryable":true
        },
        "AssetItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the asset in the maintenance organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item associated with the asset in the maintenance organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Item number of the asset that identifies the equipment instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Unique asset number that identifies the equipment instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EquipmentIdentifier":{
            "title":"Identifier",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the equipment resource instance.",
            "nullable":false,
            "x-queryable":true
        },
        "EquipmentInstanceDFF":{
            "title":"Flexfields for Equipment Instances",
            "type":"array",
            "description":"The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.",
            "items":{
                "$ref":"#/components/schemas/productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "EquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EquipmentInstanceName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the equipment resource instance.",
            "nullable":false,
            "x-queryable":true
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the equipment instance becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryWorkCenterCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the primary work center.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryWorkCenterId":{
            "title":"Primary Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center that the application assigns to this equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PrimaryWorkCenterCode"
                ]
            },
            "x-queryable":true
        },
        "PrimaryWorkCenterName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the name of the primary work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Flexfields for Equipment Instances

Type: array

Title: Flexfields for Equipment Instances

The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.

Show Source

• Array of: object productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response

{
    "title":"Flexfields for Equipment Instances",
    "type":"array",
    "description":"The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.",
    "items":{
        "$ref":"#/components/schemas/productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for equipment instances.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for equipment instances.
• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for equipment instances.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for equipment instances.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

EquipmentInstanceDFF

Operation: /fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/EquipmentInstance/{EquipmentInstanceId}/child/EquipmentInstanceDFF

Parameters:

• EquipmentInstanceId: $request.path.EquipmentInstanceId
• ResourceId: $request.path.ResourceId

The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.

Back to Top

Examples

This example describes how to update one instance.

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/productionResources/ResourceId/child/EquipmentInstance/EquipmentInstanceId"

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.

{
  "EquipmentInstanceName" : "Automatic Assembly Drilling Machine"
}

Example Response Body

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

{
  "EquipmentInstanceId" : 300100150115731,
  "EquipmentIdentifier" : "ASSY-DRILL-001",
  "EquipmentInstanceName" : "Automatic Assembly Drilling Machine",
  "AssetId" : 300100150115717,
  "AssetNumber" : "DRILL-001",
  "AssetDescription" : "Drilling Machine",
  "AssetItemId" : 300100013645842,
  "AssetItemNumber" : "alm-srl-001",
  "AssetItemDescription" : "Serialized Asset Item",
  "OrganizationId" : 207,
  "ResourceId" : 300100150115730,
  "ResourceCode" : "ASSY-DRILL-001",
  "PrimaryWorkCenterId" : null,
  "PrimaryWorkCenterCode" : null,
  "InactiveDate" : null,
  "links" : [ {
    ...
   }]
}

Back to Top