Jump to

• Request
• Response
• Examples

Update one instance

patch

/fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/LaborInstance/{LaborInstanceId}

Request

Path Parameters

• LaborInstanceId(required): integer(int64)
  Value that uniquely identifies the labor resource instance. It is a primary key that the application generates when it creates a labor 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:
  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

• InactiveDate: string (date)
  Title: Inactive On

  Date when the labor instance becomes inactive.
• LaborIdentifier: string
  Title: Identifier

  Maximum Length: 30

  Abbreviation that identifies the labor resource instance.
• LaborInstanceDFF: array Flexfields for Labor Instances
  Title: Flexfields for Labor Instances

  The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.
• LaborInstanceName: string
  Title: Name

  Maximum Length: 360

  Name of the labor resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
• PartyId: integer (int64)
  Title: Registry ID

  Value that identifies the party table in Oracle Trading Community Architecture. It is a foreign key.
• 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 assigned to this equipment instance.
• RegistryId: string
  Title: Registry ID

  Maximum Length: 30

  Value that identifies the registry from the Oracle Trading Community Architecture. This attribute is a foreign key.
• 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":{
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the labor instance becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "PartyId":{
            "title":"Registry ID",
            "type":"integer",
            "description":"Value that identifies the party table in Oracle Trading Community Architecture. It is a foreign key.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LaborInstanceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the labor resource instance.",
            "nullable":false
        },
        "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"
            }
        },
        "LaborIdentifier":{
            "title":"Identifier",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the labor resource instance.",
            "nullable":false
        },
        "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 assigned to this equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "PrimaryWorkCenterCode"
                ]
            }
        },
        "PrimaryWorkCenterCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the primary work center.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the registry from the Oracle Trading Community Architecture. This attribute is a foreign key.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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,
            "x-hints":{
                "precision":"18"
            }
        },
        "LaborInstanceDFF":{
            "title":"Flexfields for Labor Instances",
            "type":"array",
            "description":"The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.",
            "items":{
                "$ref":"#/components/schemas/productionResources-LaborInstance-LaborInstanceDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Flexfields for Labor Instances

Type: array

Title: Flexfields for Labor Instances

The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.

Show Source

• Array of: object productionResources-LaborInstance-LaborInstanceDFF-item-patch-request

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

Nested Schema : productionResources-LaborInstance-LaborInstanceDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

  Descriptive flexfield context display value for labor instances.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for labor instances.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context name for labor instances.",
            "nullable":true,
            "x-hints":{
                "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"
                }
            }
        }
    }
}

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-LaborInstance-item-response

Type: object

Show Source

• InactiveDate: string (date)
  Title: Inactive On

  Date when the labor instance becomes inactive.
• LaborIdentifier: string
  Title: Identifier

  Maximum Length: 30

  Abbreviation that identifies the labor resource instance.
• LaborInstanceDFF: array Flexfields for Labor Instances
  Title: Flexfields for Labor Instances

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

  Maximum Length: 360

  Name of the labor resource instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
• PartyId: integer (int64)
  Title: Registry ID

  Value that identifies the party table in Oracle Trading Community Architecture. It is a foreign key.
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Person name stored in Oracle Trading Community Architecture.
• PersonType: string
  Title: Usage

  Read Only: true

  Maximum Length: 30

  Type of person, such as employee, contingent worker, partner contact, and so on.
• 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 assigned to this equipment instance.
• RegistryId: string
  Title: Registry ID

  Maximum Length: 30

  Value that identifies the registry from the Oracle Trading Community Architecture. This attribute is a foreign key.
• 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":{
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the labor instance becomes inactive.",
            "format":"date",
            "nullable":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
        },
        "PersonName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Person name stored in Oracle Trading Community Architecture.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "LaborInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the labor resource instance. It is a primary key that the application generates when it creates a labor instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PersonType":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"Type of person, such as employee, contingent worker, partner contact, and so on.",
            "nullable":false,
            "readOnly":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,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Registry ID",
            "type":"integer",
            "description":"Value that identifies the party table in Oracle Trading Community Architecture. It is a foreign key.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LaborInstanceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the labor resource instance.",
            "nullable":false,
            "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
        },
        "LaborIdentifier":{
            "title":"Identifier",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the labor resource instance.",
            "nullable":false,
            "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 assigned to this equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "PrimaryWorkCenterCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegistryId":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the registry from the Oracle Trading Community Architecture. This attribute is a foreign key.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LaborInstanceDFF":{
            "title":"Flexfields for Labor Instances",
            "type":"array",
            "description":"The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.",
            "items":{
                "$ref":"#/components/schemas/productionResources-LaborInstance-LaborInstanceDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Flexfields for Labor Instances

Type: array

Title: Flexfields for Labor Instances

The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.

Show Source

• Array of: object productionResources-LaborInstance-LaborInstanceDFF-item-response

{
    "title":"Flexfields for Labor Instances",
    "type":"array",
    "description":"The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.",
    "items":{
        "$ref":"#/components/schemas/productionResources-LaborInstance-LaborInstanceDFF-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-LaborInstance-LaborInstanceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LaborInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the labor resource instance. It's a primary key that the application generates when it creates a labor instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for labor instances.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "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
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"80",
            "type":"string",
            "description":"Descriptive flexfield context name for labor instances.",
            "nullable":true,
            "x-hints":{
                "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
        }
    }
}

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

LaborInstanceDFF

Operation: /fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/LaborInstance/{LaborInstanceId}/child/LaborInstanceDFF

Parameters:

• LaborInstanceId: $request.path.LaborInstanceId
• ResourceId: $request.path.ResourceId

The Flexfields for Labor Instances resource manages descriptive flexfields that the labor 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/LaborInstance/LaborInstanceId"

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.

{
      "LaborInstanceName" : "John"
}

Example Response Body

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

{
  "LaborInstanceId" : 300100159342614,
  "LaborIdentifier" : "B12345",
  "LaborInstanceName" : "John",
  "PartyId" : null,
  "PersonName" : null,
  "PersonType" : null,
  "OrganizationId" : 207,
  "ResourceId" : 300100083871582,
  "ResourceCode" : "AG_Res1",
  "PrimaryWorkCenterId" : 300100083871587,
  "PrimaryWorkCenterCode" : "AG_workcentre1",
  "InactiveDate" : null,
  "links" : [ {
..,
}]

Back to Top