Jump to

• Request
• Response
• Examples

Create one resource

post

/fscmRestApi/resources/11.13.18.05/productionResources

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AutomationEquipmentFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the equipment performs operations automatically. If false, then the equipment requires manual intervention to perform an operation. The default value is false.
• CostedFlag: boolean
  Title: Costing enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then consider resource costs in work order costing. If false, then don't consider these costs. The default value is false.
• DefaultExpenditureTypeId: integer (int64)
  Title: Default Expenditure Type

  Value that uniquely identifies the expenditure type used for project-related transaction distributions. This attribute is associated with a feature that requires opt in.
• DefaultExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  Name of the cost classification assigned to each expenditure item. Expenditure types are grouped into cost groups and revenue groups. This attribute is associated with a feature that requires opt in.
• EquipmentInstance: array Equipment Instances
  Title: Equipment Instances

  The Equipment Instances resource manages instances of an equipment resource.
• HcmSchedulingGroupCode: string
  Maximum Length: 30

  Code to uniquely identify the schedule group that's mapped to a resource
• InactiveDate: string (date)
  Title: Inactive On

  Date when the resource becomes inactive. If the date isn't specified, the resource is considered active.
• LaborInstance: array Labor Instances
  Title: Labor Instances

  The Labor Instances resource manages instances of a labor resource.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
• ProgramFileName: array Program File Names
  Title: Program File Names

  The Program File Names resource manages the association of program files with automation equipment resources.
• ResourceClassCode: string
  Title: Class

  Maximum Length: 30

  Abbreviation that identifies the class that groups production resources. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_CLASS.
• ResourceCode(required): string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the production resource.
• ResourceDescription: string
  Title: Description

  Maximum Length: 240

  Description of the production resource.
• ResourceDFF: array ResourceDFF
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
• ResourceInstancesCount: integer
  Value that uniquely identifies the count of the resource instances for a resource.
• ResourceName(required): string
  Title: Name

  Maximum Length: 80

  Name of the production resource.
• ResourceType(required): string
  Title: Type

  Maximum Length: 30

  Value that indicates the type of the production resource. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.
• UOMCode(required): string
  Title: Usage UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure. The application uses this code for scheduling and for resource charge. To use this resource for scheduling, it must be part of a valid Time UOM class.

{
    "required":[
        "ResourceCode",
        "ResourceName",
        "ResourceType",
        "UOMCode"
    ],
    "type":"object",
    "properties":{
        "AutomationEquipmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the equipment performs operations automatically. If false, then the equipment requires manual intervention to perform an operation. The default value is false.",
            "nullable":true
        },
        "CostedFlag":{
            "title":"Costing enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then consider resource costs in work order costing. If false, then don't consider these costs. The default value is false.",
            "nullable":true
        },
        "DefaultExpenditureTypeId":{
            "title":"Default Expenditure Type",
            "type":"integer",
            "description":"Value that uniquely identifies the expenditure type used for project-related transaction distributions. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "DefaultExpenditureTypeName"
                ]
            }
        },
        "DefaultExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"Name of the cost classification assigned to each expenditure item. Expenditure types are grouped into cost groups and revenue groups. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EquipmentInstance":{
            "title":"Equipment Instances",
            "type":"array",
            "description":"The Equipment Instances resource manages instances of an equipment resource.",
            "items":{
                "$ref":"#/components/schemas/productionResources-EquipmentInstance-item-post-request"
            }
        },
        "HcmSchedulingGroupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to uniquely identify the schedule group that's mapped to a resource",
            "nullable":true
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the resource becomes inactive. If the date isn't specified, the resource is considered active.",
            "format":"date",
            "nullable":true
        },
        "LaborInstance":{
            "title":"Labor Instances",
            "type":"array",
            "description":"The Labor Instances resource manages instances of a labor resource.",
            "items":{
                "$ref":"#/components/schemas/productionResources-LaborInstance-item-post-request"
            }
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode"
                ]
            }
        },
        "ProgramFileName":{
            "title":"Program File Names",
            "type":"array",
            "description":"The Program File Names resource manages the association of program files with automation equipment resources.",
            "items":{
                "$ref":"#/components/schemas/productionResources-ProgramFileName-item-post-request"
            }
        },
        "ResourceClassCode":{
            "title":"Class",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the class that groups production resources. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_CLASS.",
            "nullable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false
        },
        "ResourceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productionResources-ResourceDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the production resource.",
            "nullable":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,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ResourceInstancesCount":{
            "type":"integer",
            "description":"Value that uniquely identifies the count of the resource instances for a resource.",
            "nullable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the production resource.",
            "nullable":false
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the production resource. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.",
            "nullable":false
        },
        "UOMCode":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure. The application uses this code for scheduling and for resource charge. To use this resource for scheduling, it must be part of a valid Time UOM class.",
            "nullable":false
        }
    }
}

Nested Schema : Equipment Instances

Type: array

Title: Equipment Instances

The Equipment Instances resource manages instances of an equipment resource.

Show Source

• Array of: object productionResources-EquipmentInstance-item-post-request

{
    "title":"Equipment Instances",
    "type":"array",
    "description":"The Equipment Instances resource manages instances of an equipment resource.",
    "items":{
        "$ref":"#/components/schemas/productionResources-EquipmentInstance-item-post-request"
    }
}

Nested Schema : Labor Instances

Type: array

Title: Labor Instances

The Labor Instances resource manages instances of a labor resource.

Show Source

• Array of: object productionResources-LaborInstance-item-post-request

{
    "title":"Labor Instances",
    "type":"array",
    "description":"The Labor Instances resource manages instances of a labor resource.",
    "items":{
        "$ref":"#/components/schemas/productionResources-LaborInstance-item-post-request"
    }
}

Nested Schema : Program File Names

Type: array

Title: Program File Names

The Program File Names resource manages the association of program files with automation equipment resources.

Show Source

• Array of: object productionResources-ProgramFileName-item-post-request

{
    "title":"Program File Names",
    "type":"array",
    "description":"The Program File Names resource manages the association of program files with automation equipment resources.",
    "items":{
        "$ref":"#/components/schemas/productionResources-ProgramFileName-item-post-request"
    }
}

Nested Schema : ResourceDFF

Type: array

Show Source

• Array of: object productionResources-ResourceDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productionResources-ResourceDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : productionResources-EquipmentInstance-item-post-request

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(required): string
  Title: Identifier

  Maximum Length: 80

  Abbreviation that identifies the equipment resource instance.
• EquipmentInstanceDFF: array EquipmentInstanceDFF
• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment resource instance. It's a primary key that the application generates when it creates a equipment instance.
• EquipmentInstanceName(required): 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's 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(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.

{
    "required":[
        "EquipmentIdentifier",
        "EquipmentInstanceName",
        "ResourceId"
    ],
    "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":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productionResources-EquipmentInstance-EquipmentInstanceDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "EquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment resource instance. It's 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"
            }
        },
        "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's 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's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : EquipmentInstanceDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productionResources-EquipmentInstance-EquipmentInstanceDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EquipmentInstanceId: integer (int64)

{
    "type":"object",
    "properties":{
        "EquipmentInstanceId":{
            "type":"integer",
            "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":"Context Segment",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

Nested Schema : productionResources-LaborInstance-item-post-request

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 LaborInstanceDFF
• 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.
• 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's 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's 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's 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's 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":{
            "type":"array",
            "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's 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's 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's 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's 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's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : LaborInstanceDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productionResources-LaborInstance-LaborInstanceDFF-item-post-request"
    },
    "x-cardinality":"1"
}

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• LaborInstanceId: integer (int64)

{
    "type":"object",
    "properties":{
        "LaborInstanceId":{
            "type":"integer",
            "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":"Context Segment",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

Nested Schema : productionResources-ProgramFileName-item-post-request

Type: object

Show Source

• EquipmentProgramFileId: integer (int64)
  Value that uniquely identifies the program file's association with the equipment.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
• ProgramFileId: integer (int64)
  Value that uniquely identifies the document item that represents the name of the program file used by the equipment.
• ProgramFileName: string
  Title: Program File Names

  Maximum Length: 300

  Name of the document item that represents the name of the program file.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.

{
    "type":"object",
    "properties":{
        "EquipmentProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program file's association with the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramFileName":{
            "title":"Program File Names",
            "maxLength":300,
            "type":"string",
            "description":"Name of the document item that represents the name of the program file.",
            "nullable":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,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : productionResources-ResourceDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• ResourceId: integer (int64)

{
    "type":"object",
    "properties":{
        "ResourceId":{
            "type":"integer",
            "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":"Context Segment",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

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

Type: object

Show Source

• AutomationEquipmentFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the equipment performs operations automatically. If false, then the equipment requires manual intervention to perform an operation. The default value is false.
• CostedFlag: boolean
  Title: Costing enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then consider resource costs in work order costing. If false, then don't consider these costs. The default value is false.
• DefaultExpenditureTypeId: integer (int64)
  Title: Default Expenditure Type

  Value that uniquely identifies the expenditure type used for project-related transaction distributions. This attribute is associated with a feature that requires opt in.
• DefaultExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  Name of the cost classification assigned to each expenditure item. Expenditure types are grouped into cost groups and revenue groups. This attribute is associated with a feature that requires opt in.
• EquipmentInstance: array Equipment Instances
  Title: Equipment Instances

  The Equipment Instances resource manages instances of an equipment resource.
• HcmSchedulingGroupCode: string
  Maximum Length: 30

  Code to uniquely identify the schedule group that's mapped to a resource
• HcmSchedulingGroupName: string
  Read Only: true

  Maximum Length: 255

  Name of the scheduling group that's mapped to a resource
• InactiveDate: string (date)
  Title: Inactive On

  Date when the resource becomes inactive. If the date isn't specified, the resource is considered active.
• LaborInstance: array Labor Instances
  Title: Labor Instances

  The Labor Instances resource manages instances of a labor resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Maximum Length: 18

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

  Maximum Length: 240

  Name of the inventory organization.
• ProgramFileName: array Program File Names
  Title: Program File Names

  The Program File Names resource manages the association of program files with automation equipment resources.
• ResourceClassCode: string
  Title: Class

  Maximum Length: 30

  Abbreviation that identifies the class that groups production resources. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_CLASS.
• ResourceClassMeaning: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the meaning of the class that groups the production resources.
• ResourceCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the production resource.
• ResourceDescription: string
  Title: Description

  Maximum Length: 240

  Description of the production resource.
• ResourceDFF: array ResourceDFF
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
• ResourceInstancesCount: integer
  Value that uniquely identifies the count of the resource instances for a resource.
• ResourceName: string
  Title: Name

  Maximum Length: 80

  Name of the production resource.
• ResourceType: string
  Title: Type

  Maximum Length: 30

  Value that indicates the type of the production resource. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.
• ResourceTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning of the resource type.
• Status: string
  Read Only: true

  Maximum Length: 255

  Value that identifies if the resource is active or inactive.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Title: Usage UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure. The application uses this code for scheduling and for resource charge. To use this resource for scheduling, it must be part of a valid Time UOM class.

{
    "type":"object",
    "properties":{
        "AutomationEquipmentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the equipment performs operations automatically. If false, then the equipment requires manual intervention to perform an operation. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "CostedFlag":{
            "title":"Costing enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then consider resource costs in work order costing. If false, then don't consider these costs. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultExpenditureTypeId":{
            "title":"Default Expenditure Type",
            "type":"integer",
            "description":"Value that uniquely identifies the expenditure type used for project-related transaction distributions. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "DefaultExpenditureTypeName"
                ]
            },
            "x-queryable":true
        },
        "DefaultExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"Name of the cost classification assigned to each expenditure item. Expenditure types are grouped into cost groups and revenue groups. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EquipmentInstance":{
            "title":"Equipment Instances",
            "type":"array",
            "description":"The Equipment Instances resource manages instances of an equipment resource.",
            "items":{
                "$ref":"#/components/schemas/productionResources-EquipmentInstance-item-response"
            }
        },
        "HcmSchedulingGroupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to uniquely identify the schedule group that's mapped to a resource",
            "nullable":true,
            "x-queryable":true
        },
        "HcmSchedulingGroupName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the scheduling group that's mapped to a resource",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the resource becomes inactive. If the date isn't specified, the resource is considered active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LaborInstance":{
            "title":"Labor Instances",
            "type":"array",
            "description":"The Labor Instances resource manages instances of a labor resource.",
            "items":{
                "$ref":"#/components/schemas/productionResources-LaborInstance-item-response"
            }
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode"
                ]
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramFileName":{
            "title":"Program File Names",
            "type":"array",
            "description":"The Program File Names resource manages the association of program files with automation equipment resources.",
            "items":{
                "$ref":"#/components/schemas/productionResources-ProgramFileName-item-response"
            }
        },
        "ResourceClassCode":{
            "title":"Class",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the class that groups production resources. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_CLASS.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceClassMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the meaning of the class that groups the production resources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productionResources-ResourceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the production resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResourceInstancesCount":{
            "type":"integer",
            "description":"Value that uniquely identifies the count of the resource instances for a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the production resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the production resource. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the resource type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies if the resource is active or inactive.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InactiveDate"
                ]
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"Usage UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure. The application uses this code for scheduling and for resource charge. To use this resource for scheduling, it must be part of a valid Time UOM class.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Equipment Instances

Type: array

Title: Equipment Instances

The Equipment Instances resource manages instances of an equipment resource.

Show Source

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

{
    "title":"Equipment Instances",
    "type":"array",
    "description":"The Equipment Instances resource manages instances of an equipment resource.",
    "items":{
        "$ref":"#/components/schemas/productionResources-EquipmentInstance-item-response"
    }
}

Nested Schema : Labor Instances

Type: array

Title: Labor Instances

The Labor Instances resource manages instances of a labor resource.

Show Source

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

{
    "title":"Labor Instances",
    "type":"array",
    "description":"The Labor Instances resource manages instances of a labor resource.",
    "items":{
        "$ref":"#/components/schemas/productionResources-LaborInstance-item-response"
    }
}

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 : Program File Names

Type: array

Title: Program File Names

The Program File Names resource manages the association of program files with automation equipment resources.

Show Source

• Array of: object productionResources-ProgramFileName-item-response

{
    "title":"Program File Names",
    "type":"array",
    "description":"The Program File Names resource manages the association of program files with automation equipment resources.",
    "items":{
        "$ref":"#/components/schemas/productionResources-ProgramFileName-item-response"
    }
}

Nested Schema : ResourceDFF

Type: array

Show Source

• Array of: object productionResources-ResourceDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productionResources-ResourceDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested 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 EquipmentInstanceDFF
• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment resource instance. It's 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's 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's 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's 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":{
            "type":"array",
            "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's 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's 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's 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's 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 : EquipmentInstanceDFF

Type: array

Show Source

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

{
    "type":"array",
    "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

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• EquipmentInstanceId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EquipmentInstanceId":{
            "type":"integer",
            "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":"Context Segment",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "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."
        }
    }
}

Nested 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 LaborInstanceDFF
• 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.
• 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's 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's 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

  Phone 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's 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's 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":{
            "type":"array",
            "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's 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's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Registry ID",
            "type":"integer",
            "description":"Value that identifies the party table in Oracle Trading Community Architecture. It's 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":"Phone 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's 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's 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 : LaborInstanceDFF

Type: array

Show Source

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

{
    "type":"array",
    "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

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• LaborInstanceId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LaborInstanceId":{
            "type":"integer",
            "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":"Context Segment",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "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 : productionResources-ProgramFileName-item-response

Type: object

Show Source

• CurrentRevision: string
  Read Only: true

  Maximum Length: 18

  Current revision of the document item that represents the current revision of the program file.
• EquipmentProgramFileId: integer (int64)
  Value that uniquely identifies the program file's association with the equipment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
• ProgramFileId: integer (int64)
  Value that uniquely identifies the document item that represents the name of the program file used by the equipment.
• ProgramFileName: string
  Title: Program File Names

  Maximum Length: 300

  Name of the document item that represents the name of the program file.
• ResourceCode: string
  Read Only: true

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "CurrentRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Current revision of the document item that represents the current revision of the program file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EquipmentProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program file's association with the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramFileName":{
            "title":"Program File Names",
            "maxLength":300,
            "type":"string",
            "description":"Name of the document item that represents the name of the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "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 : 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-ResourceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceId: integer (int64)

{
    "type":"object",
    "properties":{
        "ResourceId":{
            "type":"integer",
            "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":"Context Segment",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "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"
    }
}

Links

EquipmentInstance

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

Parameters:

• ResourceId: $request.path.ResourceId

The Equipment Instances resource manages instances of an equipment resource.

LaborInstance

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

Parameters:

• ResourceId: $request.path.ResourceId

The Labor Instances resource manages instances of a labor resource.

ProgramFileName

Operation: /fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/ProgramFileName

Parameters:

• ResourceId: $request.path.ResourceId

The Program File Names resource manages the association of program files with automation equipment resources.

ResourceDFF

Operation: /fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/ResourceDFF

Parameters:

• ResourceId: $request.path.ResourceId

Back to Top

Examples

This example describes how to create one resource.

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"

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.

{
    "OrganizationId" : 207,
    "ResourceName" : "MACHINIST",
    "ResourceDescription" : "Lathe Machinist",
    "ResourceCode" : "MACHINIST",
    "ResourceType" : "LABOR",
    "UOMCode" : "HRS"
}

Example Response Body

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

{
  "OrganizationId" : 207,
  "OrganizationCode" : null,
  "OrganizationName" : null,
  "ResourceId" : 300100153743091,
  "ResourceName" : "MACHINIST",
  "ResourceDescription" : "Lathe Machinist",
  "ResourceCode" : "MACHINIST",
  "ResourceType" : "LABOR",
  "UOMCode" : "HRS",
  "UnitOfMeasure" : "HRS",
  "ResourceClassCode" : null,
  "CostedFlag" : false,
  "InactiveDate" : null,
  "links" : [ {
...
}]

Back to Top