Jump to

• Request
• Response

Get one resource

get

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource/{ProcessWorkOrderResourceUniqID}

Request

Path Parameters

• ProcessWorkOrderResourceUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Order Resources resource and used to uniquely identify an instance of Work Order Resources. The client should not generate the hash key value. Instead, the client should query on the Work Order Resources collection resource in order to navigate to a specific instance of Work Order Resources to get the hash key.
• processWorkOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.

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:
  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 : processWorkOrders-ProcessWorkOrderResource-item-response

Type: object

Show Source

• ActualResourceUsage: number
  Title: Actual Resource Usage

  Read Only: true

  Net actual usage of the assigned resource.
• AssignedUnits: number
  Title: Assigned Units

  Default Value: 1

  Number of resource units required to perform the operation.
• BasisType: string
  Title: Basis

  Maximum Length: 30

  Default Value: 1

  Value that indicates whether the resource quantity is fixed; for example, usage per lot produced, or variable; for example, usage per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
• ChargeType: string
  Title: Charge Type

  Maximum Length: 30

  Value that indicates whether resource transactions are automatically generated and at what stage. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the process work order operation resource.
• CreationDate: string (date-time)
  Read Only: true

  Date when the used created the work order operation resource.
• EquipmentProfileCode: string
  Maximum Length: 255

  Abbreviation that identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
• EquipmentProfileId: integer (int64)
  Title: Equipment Profile

  Value that uniquely identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the work order operation resource.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who updated the process work order resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the operation that processes the resource.
• OperationSequenceNumber: number
  Title: Operation Sequence

  Read Only: true

  Number that indicates the sequence to use when performing the work order operations.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
• PhantomFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the resource associated with this operation is pulled in as part of a phantom explosion that pulled in the resources from the work definition of a phantom material tied to the operation. If false, then the resource is not a part of phantom explosion. The default value is false.
• PlannedCompletionDate: string (date-time)
  Title: Completion Date

  Planned date and time till the resource is engaged for the operation. The scheduling application sets this date. The planned completion date must not occur before the operation start date or after the operation finish date. This attribute is required.
• PlannedStartDate: string (date-time)
  Title: Start Date

  Planned date and time to engage the resource for the operation. The scheduling application sets this date. The planned start date must not occur before the operation start date or after the operation finish date. This attribute is required.
• PrincipalFlag: boolean
  Title: Principal

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then this resource is the principal resource among the group of simultaneous resources for that operation sequence. If false, then this resource is not the principal resource. This attribute does not have a default value.
• ProfileCode: string
  Maximum Length: 255

  Abbreviation that identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
• ProfileId: integer (int64)
  Value that uniquely identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
• RequiredUsage: number
  Title: Required Usage

  Resource usage that the plant requires to make the work order quantity. The application calculates this value depending on whether the basis type is fixed or variable. Fixed: the required usage equals the usage rate. Variable: the required usage equals the usage rate multiplied by the work order quantity.
• ResourceActivityCode: string
  Title: Activity

  Maximum Length: 30

  Abbreviation that identifies the resource activity.
• ResourceAttachment: array Resource Attachments
  Title: Resource Attachments

  The Resource Attachments resource manages the attachments for a resource.
• ResourceCode: string
  Title: Code

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

  Description of the resource.
• ResourceDFF: array Flexfields for Resources
  Title: Flexfields for Resources

  The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.
• ResourceExceptionCount: array Exceptions for Operation Resources
  Title: Exceptions for Operation Resources

  The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource. It's a primary key that the application generates when it creates the resource.
• ResourceInstance: array Resource Instances
  Title: Resource Instances

  The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the resource.
• ResourceSequenceNumber: number
  Title: Sequence

  Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time.
• ResourceType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Type of the resource. Values include Labor or Equipment.
• ScheduledIndicator: string
  Title: Scheduled

  Maximum Length: 30

  Contains one of the following values: true or false. If true, then scheduling schedules the resource and computes the start date and completion date. If false, then scheduling does not schedule the resource and sets the start date equal to the completion date. The default value is true.
• StandardOperationCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the standard operation.
• StandardOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the standard operation of a work order. It's a primary key that the application generates when it creates the operation.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure that the resource uses.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the resource uses.
• WorkAreaCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work area.
• WorkAreaDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work area.
• WorkAreaId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
• WorkAreaName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the work area.
• WorkCenterCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work center.
• WorkCenterDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the work center.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
• WorkOrderOperationResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the used created the work order operation resource.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceActivityCode":{
            "title":"Activity",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the resource activity.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation of a work order. It's a primary key that the application generates when it creates the operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlannedCompletionDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"Planned date and time till the resource is engaged for the operation. The scheduling application sets this date. The planned completion date must not occur before the operation start date or after the operation finish date. This attribute is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentProfileCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlannedStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Planned date and time to engage the resource for the operation. The scheduling application sets this date. The planned start date must not occur before the operation start date or after the operation finish date. This attribute is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrincipalFlag":{
            "title":"Principal",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then this resource is the principal resource among the group of simultaneous resources for that operation sequence. If false, then this resource is not the principal resource. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceExceptionCount":{
            "title":"Exceptions for Operation Resources",
            "type":"array",
            "description":"The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceExceptionCount-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActualResourceUsage":{
            "title":"Actual Resource Usage",
            "type":"number",
            "description":"Net actual usage of the assigned resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who updated the process work order resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the standard operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhantomFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the resource associated with this operation is pulled in as part of a phantom explosion that pulled in the resources from the work definition of a phantom material tied to the operation. If false, then the resource is not a part of phantom explosion. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the process work order operation resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "RequiredUsage":{
            "title":"Required Usage",
            "type":"number",
            "description":"Resource usage that the plant requires to make the work order quantity. The application calculates this value depending on whether the basis type is fixed or variable. Fixed: the required usage equals the usage rate. Variable: the required usage equals the usage rate multiplied by the work order quantity.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceAttachment":{
            "title":"Resource Attachments",
            "type":"array",
            "description":"The Resource Attachments resource manages the attachments for a resource.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceAttachment-item-response"
            }
        },
        "OperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the operation that processes the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceDFF":{
            "title":"Flexfields for Resources",
            "type":"array",
            "description":"The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the resource. Values include Labor or Equipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkAreaCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledIndicator":{
            "title":"Scheduled",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then scheduling schedules the resource and computes the start date and completion date. If false, then scheduling does not schedule the resource and sets the start date equal to the completion date. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedUnits":{
            "title":"Assigned Units",
            "type":"number",
            "description":"Number of resource units required to perform the operation.",
            "nullable":false,
            "default":"1",
            "x-queryable":false
        },
        "BasisType":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether the resource quantity is fixed; for example, usage per lot produced, or variable; for example, usage per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource. It's a primary key that the application generates when it creates the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChargeType":{
            "title":"Charge Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether resource transactions are automatically generated and at what stage. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Number that indicates the sequence to use when performing the work order operations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstance":{
            "title":"Resource Instances",
            "type":"array",
            "description":"The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceInstance-item-response"
            }
        },
        "EquipmentProfileId":{
            "title":"Equipment Profile",
            "type":"integer",
            "description":"Value that uniquely identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "EquipmentProfileCode"
                ]
            },
            "x-queryable":true
        },
        "WorkOrderOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the work order operation resource.",
            "format":"date-time",
            "nullable":false,
            "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 : Resource Attachments

Type: array

Title: Resource Attachments

The Resource Attachments resource manages the attachments for a resource.

Show Source

• Array of: object processWorkOrders-ProcessWorkOrderResource-ResourceAttachment-item-response

{
    "title":"Resource Attachments",
    "type":"array",
    "description":"The Resource Attachments resource manages the attachments for a resource.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceAttachment-item-response"
    }
}

Nested Schema : Flexfields for Resources

Type: array

Title: Flexfields for Resources

The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.

Show Source

• Array of: object processWorkOrders-ProcessWorkOrderResource-ResourceDFF-item-response

{
    "title":"Flexfields for Resources",
    "type":"array",
    "description":"The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Exceptions for Operation Resources

Type: array

Title: Exceptions for Operation Resources

The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.

Show Source

• Array of: object processWorkOrders-ProcessWorkOrderResource-ResourceExceptionCount-item-response

{
    "title":"Exceptions for Operation Resources",
    "type":"array",
    "description":"The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceExceptionCount-item-response"
    }
}

Nested Schema : Resource Instances

Type: array

Title: Resource Instances

The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.

Show Source

• Array of: object processWorkOrders-ProcessWorkOrderResource-ResourceInstance-item-response

{
    "title":"Resource Instances",
    "type":"array",
    "description":"The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceInstance-item-response"
    }
}

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 : processWorkOrders-ProcessWorkOrderResource-ResourceAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment of a work order operation material. It's a primary key that the application generates when a document is attached to the work order operation material.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the attachment record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the current version of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents of the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the document that's attached to the work order.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who most recently updated the document that's attached to the work order.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document that's attached to the work order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when adding or modifying the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment of a work order operation material. It's a primary key that the application generates when a document is attached to the work order operation material.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the current version of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"Login of the user who most recently updated the document that's attached to the work order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document that's attached to the work order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the document that's attached to the work order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : processWorkOrders-ProcessWorkOrderResource-ResourceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for work order operation resources.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WoOperationResourceId: integer (int64)
  Value that uniquely identifies a resource of a work order operation. It's a primary key that the application generates when it creates the work order operation resource.

{
    "type":"object",
    "properties":{
        "WoOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a resource of a work order operation. It's a primary key that the application generates when it creates the work order operation resource.",
            "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",
            "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 work order operation resources.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceExceptionCount-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
• WorkOrderOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
• WorkOrderResourceExceptionCount: integer
  Read Only: true

  Count of the open exceptions of the Resource type for this work order.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderResourceExceptionCount":{
            "type":"integer",
            "description":"Count of the open exceptions of the Resource type for this work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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 resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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 : processWorkOrders-ProcessWorkOrderResource-ResourceInstance-item-response

Type: object

Show Source

• ChargedQuantity: number
  Title: Actual Usage

  Read Only: true

  Actual usage of the resource instance.
• CurrentRevision: string
  Maximum Length: 255

  Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
• EquipmentInstanceCode: string
  Title: Identifier

  Maximum Length: 80

  Abbreviation that identifies the equipment resource instance.
• 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

  Read Only: true

  Maximum Length: 120

  Name of the equipment resource instance.
• EquipmentParameterFileContent: string (byte)
  Read Only: true

  Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the resource instance of the work order operation.
• EquipmentParameterFileName: string
  Read Only: true

  Maximum Length: 512

  Name of the equipment parameters flat file associated with the resource instance of the work order operation.
• LaborInstanceCode: string
  Title: Identifier

  Maximum Length: 30

  Abbreviation that identifies the labor resource instance.
• 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

  Read Only: true

  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)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
• ProgramFileId: integer (int64)
  Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment.
• ProgramFileName: string
  Maximum Length: 300

  Name of the program file associated with the automation equipment resource and used by the work order resource instance.
• ResourceInstanceDFF: array Flexfields for Resource Instances
  Title: Flexfields for Resource Instances

  The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.
• ResourceType: string
  Read Only: true

  Maximum Length: 255

  Type of the resource. Values include Labor or Equipment.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
• WorkOrderOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
• WorkOrderOperationResourceId: integer (int64)
  Value that uniquely identifies the resource of a work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
• WorkOrderOperationResourceInstanceId: integer (int64)
  Value that uniquely identifies the resource instance of a work order operation resource. It's a primary key that the application generates when it creates the resource instance for the work order operation resource.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EquipmentInstanceCode":{
            "title":"Identifier",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the equipment resource instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":"300",
            "type":"string",
            "description":"Name of the program file associated with the automation equipment resource and used by the work order resource instance.",
            "nullable":true,
            "x-queryable":true
        },
        "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":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of the resource. Values include Labor or Equipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the 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's a primary key that the application generates when it creates a equipment instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrentRevision":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameters flat file associated with the resource instance of the work order operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LaborInstanceCode":{
            "title":"Identifier",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the labor resource instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LaborInstanceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the labor resource instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderOperationResourceInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource instance of a work order operation resource. It's a primary key that the application generates when it creates the resource instance for the work order operation resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChargedQuantity":{
            "title":"Actual Usage",
            "type":"number",
            "description":"Actual usage of the resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EquipmentInstanceName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the equipment resource instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EquipmentParameterFileContent":{
            "type":"string",
            "description":"Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the resource instance of the work order operation.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceInstanceDFF":{
            "title":"Flexfields for Resource Instances",
            "type":"array",
            "description":"The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.",
            "items":{
                "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceInstance-ResourceInstanceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "WorkOrderOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource of a work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : Flexfields for Resource Instances

Type: array

Title: Flexfields for Resource Instances

The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.

Show Source

• Array of: object processWorkOrders-ProcessWorkOrderResource-ResourceInstance-ResourceInstanceDFF-item-response

{
    "title":"Flexfields for Resource Instances",
    "type":"array",
    "description":"The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.",
    "items":{
        "$ref":"#/components/schemas/processWorkOrders-ProcessWorkOrderResource-ResourceInstance-ResourceInstanceDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceInstance-ResourceInstanceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for work order operation resource instance.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for work order operation resource instance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WoOpResourceInstanceId: integer (int64)
  Value that uniquely identifies an output of a work order operation resource instance. It's a primary key that the application generates when it creates the work order operation resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WoOpResourceInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies an output of a work order operation resource instance. It's a primary key that the application generates when it creates the work order operation resource 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 work order operation resource instance.",
            "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 work order operation resource instance.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

ResourceAttachment

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource/{ProcessWorkOrderResourceUniqID}/child/ResourceAttachment

Parameters:

• ProcessWorkOrderResourceUniqID: $request.path.ProcessWorkOrderResourceUniqID
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Resource Attachments resource manages the attachments for a resource.

ResourceDFF

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource/{ProcessWorkOrderResourceUniqID}/child/ResourceDFF

Parameters:

• ProcessWorkOrderResourceUniqID: $request.path.ProcessWorkOrderResourceUniqID
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.

ResourceExceptionCount

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource/{ProcessWorkOrderResourceUniqID}/child/ResourceExceptionCount

Parameters:

• ProcessWorkOrderResourceUniqID: $request.path.ProcessWorkOrderResourceUniqID
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.

ResourceInstance

Operation: /fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource/{ProcessWorkOrderResourceUniqID}/child/ResourceInstance

Parameters:

• ProcessWorkOrderResourceUniqID: $request.path.ProcessWorkOrderResourceUniqID
• processWorkOrdersUniqID: $request.path.processWorkOrdersUniqID

The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.

Back to Top