Jump to

• Request
• Response

Get one instance

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/WorkOrderOperation/{WoOperationId}/child/WorkOrderOperationResource/{WoOperationResourceId}/child/WorkOrderOperationResourceInstance/{WoOperationResourceInstanceId}

Request

Path Parameters

• WoOperationId(required): integer(int64)
  Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the work order operation.
• WoOperationResourceId(required): integer(int64)
  Value that uniquely identifies the work order operation resource. It is a primary key that the application generates when it creates the work order operation resource.
• WoOperationResourceInstanceId(required): integer(int64)
  Value that uniquely identifies the resource instance for the work order operation resource. The value is generated when the resource instance is created. This attribute is read-only.
• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.

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 : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-item-response

Type: object

Show Source

• EquipmentInstanceCode: string
  Maximum Length: 255

  Abbreviation that identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
• EquipmentInstanceId: integer (int64)
  Value that uniquely identifies the equipment resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.
• EquipmentInstanceIdentifier: string
  Title: Identifier

  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
• EquipmentInstanceName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name of the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
• LaborInstanceCode: string
  Maximum Length: 255

  Abbreviation that identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.
• LaborInstanceId: integer (int64)
  Value that uniquely identifies the labor resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.
• LaborInstanceIdentifier: string
  Title: Identifier

  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.
• LaborInstanceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization in which the work order is performed. This attribute is read-only. The value of this attribute is derived from the work order.
• WoOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is derived from the operation.
• WoOperationResourceId: integer (int64)
  Value that uniquely identifies work order resource to which the resource instance is added. The operation resource identifier is required to create an operation resource instance.
• WoOperationResourceInstanceId: integer (int64)
  Value that uniquely identifies the resource instance for the work order operation resource. The value is generated when the resource instance is created. This attribute is read-only.
• WorkOrderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order.
• WorkOrderOperationResourceInstanceDFF: 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.

{
    "type":"object",
    "properties":{
        "EquipmentInstanceCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LaborInstanceIdentifier":{
            "title":"Identifier",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationResourceInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource instance for the work order operation resource. The value is generated when the resource instance is created. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WoOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies work order resource to which the resource instance is added. The operation resource identifier is required to create an operation resource instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LaborInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the labor resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization in which the work order is performed. This attribute is read-only. The value of this attribute is derived from the work order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EquipmentInstanceIdentifier":{
            "title":"Identifier",
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EquipmentInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the equipment resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LaborInstanceCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from 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 assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is derived from the operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EquipmentInstanceName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkOrderOperationResourceInstanceDFF":{
            "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/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-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 : 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 maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-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/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

  Descriptive flexfield number of segments for work order operation resource instances.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WoOpResourceInstanceId: integer (int64)
  Value that uniquely identifies the work order operation resource instance. It is 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 the work order operation resource instance. It is 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 number of segments for work order operation resource 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 work order operation resource instances.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

WorkOrderOperationResourceInstanceDFF

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/WorkOrderOperation/{WoOperationId}/child/WorkOrderOperationResource/{WoOperationResourceId}/child/WorkOrderOperationResourceInstance/{WoOperationResourceInstanceId}/child/WorkOrderOperationResourceInstanceDFF

Parameters:

• WoOperationId: $request.path.WoOperationId
• WoOperationResourceId: $request.path.WoOperationResourceId
• WoOperationResourceInstanceId: $request.path.WoOperationResourceInstanceId
• WorkOrderId: $request.path.WorkOrderId

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

Back to Top