Jump to

• Request
• Response

Create instances

post

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

Request

Path Parameters

• WoOperationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• WoOperationResourceId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• WorkOrderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• 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.
• PersonId: integer (int64)
  The person identifier of the worker assigned to the work order operation resource requirement.
• PersonNumber: string
  Maximum Length: 255

  A number assigned to a person to uniquely identify them in any context.
• WoOperationResourceId(required): 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.
• WorkOrderOperationResourceInstanceDFF: array WorkOrderOperationResourceInstanceDFF

{
    "required":[
        "WoOperationResourceId"
    ],
    "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"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"The person identifier of the worker assigned to the work order operation resource requirement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"A number assigned to a person to uniquely identify them in any context.",
            "nullable":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
            }
        },
        "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"
            }
        },
        "WorkOrderOperationResourceInstanceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-post-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : WorkOrderOperationResourceInstanceDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• WoOpResourceInstanceId: integer (int64)

{
    "type":"object",
    "properties":{
        "WoOpResourceInstanceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : 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.
• PersonId: integer (int64)
  The person identifier of the worker assigned to the work order operation resource requirement.
• PersonName: string
  Read Only: true

  Maximum Length: 255

  The name assigned to a person to uniquely identify them in any context.
• PersonNumber: string
  Maximum Length: 255

  A number assigned to a person to uniquely identify them in any context.
• 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 WorkOrderOperationResourceInstanceDFF

{
    "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PersonId":{
            "type":"integer",
            "description":"The person identifier of the worker assigned to the work order operation resource requirement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":255,
            "type":"string",
            "description":"The name assigned to a person to uniquely identify them in any context.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"A number assigned to a person to uniquely identify them in any context.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "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
        },
        "WorkOrderOperationResourceInstanceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : WorkOrderOperationResourceInstanceDFF

Type: array

Show Source

• Array of: object maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-response

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

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "WoOpResourceInstanceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

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

Back to Top