Jump to

• Request
• Response
• Examples

Get one resource

get

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

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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.
• InactiveDate: string (date)
  Title: Inactive On

  Date when the resource becomes inactive. If the date is not 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.
• 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 Flexfields for Resources
  Title: Flexfields for Resources

  The Flexfields for Resources resource manages descriptive flexfields that the production resource uses.
• 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.
• 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.
• 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":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InactiveDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date when the resource becomes inactive. If the date is not specified, the resource is considered active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the production resource.",
            "nullable":false,
            "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"
            }
        },
        "ResourceDFF":{
            "title":"Flexfields for Resources",
            "type":"array",
            "description":"The Flexfields for Resources resource manages descriptive flexfields that the production resource uses.",
            "items":{
                "$ref":"#/components/schemas/productionResources-ResourceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "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
        },
        "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
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the production resource.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

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 : Flexfields for Resources

Type: array

Title: Flexfields for Resources

The Flexfields for Resources resource manages descriptive flexfields that the production resource uses.

Show Source

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

{
    "title":"Flexfields for Resources",
    "type":"array",
    "description":"The Flexfields for Resources resource manages descriptive flexfields that the production resource uses.",
    "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 Flexfields for Equipment Instances
  Title: Flexfields for Equipment Instances

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

  Maximum Length: 120

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

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

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

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

  Maximum Length: 30

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

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

Nested Schema : Flexfields for Equipment Instances

Type: array

Title: Flexfields for Equipment Instances

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

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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 Flexfields for Labor Instances
  Title: Flexfields for Labor Instances

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

  Maximum Length: 360

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

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

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

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 30

  Type of person, such as employee, contingent worker, partner contact, and so on.
• PrimaryWorkCenterCode: string
  Title: Code

  Maximum Length: 30

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

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

  Maximum Length: 30

  Value that identifies the registry from the Oracle Trading Community Architecture. This attribute is a foreign key.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

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

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

Nested Schema : Flexfields for Labor Instances

Type: array

Title: Flexfields for Labor Instances

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

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productionResources-LaborInstance-LaborInstanceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : 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
  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":{
        "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
        },
        "ProgramFileName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the document item that represents the name of the program file.",
            "nullable":true,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        }
    }
}

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

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

  Descriptive flexfield context display value for resources.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. You can use a flexfield with this production resource. A flexfield is a flexible data field that your organization can use to modify your implementation without having to write programming code.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. You can use a flexfield with this production resource. A flexfield is a flexible data field that your organization can use to modify your implementation without having to write programming code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for resources.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for resources.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

The Flexfields for Resources resource manages descriptive flexfields that the production resource uses.

Back to Top

Examples

This example describes how to get one production resource.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/productionResources/ResourceId"

For example, the following command gets production resource 300100071642898:

curl -u username:password "https://servername/fscmRestApi/resources/version/productionResources/300100071642898"

Example Response Body

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

{
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "OrganizationName" : "Tall Manufacturing",
    "ResourceId" : 300100071642898,
    "ResourceName" : "M-Assl2",
    "ResourceDescription" : "M-Assl2",
    "ResourceCode" : "M-Assl2",
    "ResourceType" : "LABOR",
    "UnitOfMeasure" : "HRS",
    "ResourceClassCode" : null,
    "CostedFlag" : true,
    "InactiveDate" : null
}

Back to Top