REST API for Oracle Fusion Cloud SCM

Create one instance

post

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

Request

Path Parameters

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.
Upsert-Mode: string

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

InactiveDate: string (date)

Title: Inactive On

Date when the labor instance becomes inactive.
LaborIdentifier(required): 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(required): 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(required): integer (int64)

Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.

{
    "required":[
        "LaborIdentifier",
        "LaborInstanceName",
        "ResourceId"
    ],
    "type":"object",
    "properties":{
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the labor instance becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "LaborIdentifier":{
            "title":"Identifier",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the labor resource instance.",
            "nullable":false
        },
        "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-post-request"
            },
            "x-cardinality":"1"
        },
        "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"
            }
        },
        "LaborInstanceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the labor resource instance.",
            "nullable":false
        },
        "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
            }
        },
        "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
            }
        },
        "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 assigned to this equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PrimaryWorkCenterCode"
                ]
            }
        },
        "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"
            }
        },
        "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 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 schema

{
    "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-post-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 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.

{
    "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"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for labor 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 labor 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"
                }
            }
        }
    }
}

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.

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.
PartyUsageMeaning: string

Read Only: true

Maximum Length: 255

Meaning of the party usage assigned to the party.
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.
PrimaryPhoneNumber: string

Title: Primary Phone

Read Only: true

Maximum Length: 40

Telephone number formatted in local format should exclude the country code, area code, and extension.
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
        },
        "LaborIdentifier":{
            "title":"Identifier",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the labor resource instance.",
            "nullable":false,
            "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"
        },
        "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
        },
        "LaborInstanceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the labor resource instance.",
            "nullable":false,
            "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
        },
        "PartyUsageMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the party usage assigned to the party.",
            "nullable":true,
            "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
        },
        "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
        },
        "PrimaryPhoneNumber":{
            "title":"Primary Phone",
            "maxLength":40,
            "type":"string",
            "description":"Telephone number formatted in local format should exclude the country code, area code, and extension.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "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 assigned to this equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PrimaryWorkCenterCode"
                ]
            },
            "x-queryable":true
        },
        "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
        },
        "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 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
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for labor 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 labor 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

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.

Examples

This example describes how to create one instance.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/productionResources/ResourceId/child/LaborInstance"

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 creates.

{
  "LaborIdentifier" : "B12345",
  "LaborInstanceName" : "Radhika"
}

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" : [ {
..,
}]
}