Jump to

• Request
• Response
• Examples

Get one resource

get

/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionResource/{WorkDefinitionOperationResourceId}

Request

Path Parameters

• WorkDefinitionId(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=
• WorkDefinitionOperationResourceId(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=

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: 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.

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 : workDefinitions-WorkDefinitionResource-item-response

Type: object

Show Source

• AssignedUnits: number
  Title: Units Assigned

  Read Only: true

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

  Read Only: true

  Maximum Length: 30

  Default Value: 2

  Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It doesn't change according to work order quantity. If 2, then the resource consumption isn't fixed. It might change according to work order quantity. This attribute doesn't have a default value.
• ChargeType: string
  Title: Charge Type

  Read Only: true

  Maximum Length: 30

  Contains one of the following values 1 or 2. If 1, then the user manually charges the resources. If 2, then the application automatically charges the resource when it completes the operation. This attribute doesn't have a default value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created this record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• 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.
• 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 work definition operation resource.
• EquipmentParameterFileName: string
  Read Only: true

  Maximum Length: 512

  Name of the equipment parameter's flat file associated with the work definition operation's resource.
• EquipmentProfileCode: string
  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Value that uniquely identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.
• InverseUsageRate: number
  Title: Inverse Usage

  Read Only: true

  Rate that indicates the inverse resource usage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when record was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• 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.
• OperationSequenceNumber: number
  Title: 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 the application enabled for manufacturing. It's a primary key that the application generates when it creates the inventory organization.
• PrincipalFlag: boolean
  Title: Principal

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value.
• ProfileCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.
• ProfileId: integer (int64)
  Read Only: true

  Value that uniquely identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.
• ProgramFileId: integer (int64)
  Read Only: true

  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: 255

  Value that uniquely identifies the document item that represents the program file.
• ResourceActivityCode: string
  Title: Activity

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the resource activity.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

  Description of the resource.
• ResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the production resource. It's a primary key that the application generates when it consumes the production resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  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

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

  Read Only: true

  Maximum Length: 30

  Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource and the application sets the start date equal to the completion date. This attribute doesn't have a default value.
• 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 that the work definition operation references. It's a primary key that the application generates when it creates the standard operation.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure that the resource uses.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the resource uses.
• UsageRate: number
  Title: Usage

  Read Only: true

  Rate of the resource that the plant requires to make each unit of the item.
• 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)
  Read Only: true

  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.
• WorkDefinitionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work definition. It's a primary key that the application generates when it creates the work definition.
• WorkDefinitionOperationAlternateResource: array Alternate Resources
  Title: Alternate Resources

  The Alternate Resources resource gets the alternate resources that the work definition operation uses.
• WorkDefinitionOperationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work definition operation. It's a primary key that the application generates when it creates the work definition operation.
• WorkDefinitionOperationResourceAttachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• WorkDefinitionOperationResourceDFF: array WorkDefinitionOperationResourceDFF
• WorkDefinitionOperationResourceId: integer (int64)
  Read Only: true

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

{
    "type":"object",
    "properties":{
        "AssignedUnits":{
            "title":"Units Assigned",
            "type":"number",
            "description":"Number of resource units the application assigns to perform the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BasisType":{
            "title":"Basis",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It doesn't change according to work order quantity. If 2, then the resource consumption isn't fixed. It might change according to work order quantity. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "default":"2",
            "x-queryable":true
        },
        "ChargeType":{
            "title":"Charge Type",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values 1 or 2. If 1, then the user manually charges the resources. If 2, then the application automatically charges the resource when it completes the operation. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "EquipmentParameterFileContent":{
            "type":"string",
            "description":"Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation resource.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EquipmentParameterFileName":{
            "maxLength":512,
            "type":"string",
            "description":"Name of the equipment parameter's flat file associated with the work definition operation's resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EquipmentProfileCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EquipmentProfileId":{
            "title":"Equipment Profile",
            "type":"integer",
            "description":"Value that uniquely identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InverseUsageRate":{
            "title":"Inverse Usage",
            "type":"number",
            "description":"Rate that indicates the inverse resource usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Sequence",
            "type":"number",
            "description":"Number that indicates the sequence to use when performing the work order operations.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It's a primary key that the application generates when it creates the inventory organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrincipalFlag":{
            "title":"Principal",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt-in.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the document item that represents the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceActivityCode":{
            "title":"Activity",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the resource activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it consumes the production resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Category of the resource. Values include Labor or Equipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledIndicator":{
            "title":"Scheduled",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource and the application sets the start date equal to the completion date. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the standard operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation that the work definition operation references. It's a primary key that the application generates when it creates the standard operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "UsageRate":{
            "title":"Usage",
            "type":"number",
            "description":"Rate of the resource that the plant requires to make each unit of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "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
        },
        "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
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "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,
            "readOnly":true,
            "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
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition. It's a primary key that the application generates when it creates the work definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionOperationAlternateResource":{
            "title":"Alternate Resources",
            "type":"array",
            "description":"The Alternate Resources resource gets the alternate resources that the work definition operation uses.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionResource-WorkDefinitionOperationAlternateResource-item-response"
            }
        },
        "WorkDefinitionOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation. It's a primary key that the application generates when it creates the work definition operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionOperationResourceAttachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceAttachment-item-response"
            }
        },
        "WorkDefinitionOperationResourceDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "WorkDefinitionOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource for the work definition operation. It's a primary key that the application generates when it creates the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "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"
            }
        }
    }
}

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 : Alternate Resources

Type: array

Title: Alternate Resources

The Alternate Resources resource gets the alternate resources that the work definition operation uses.

Show Source

• Array of: object workDefinitions-WorkDefinitionResource-WorkDefinitionOperationAlternateResource-item-response

{
    "title":"Alternate Resources",
    "type":"array",
    "description":"The Alternate Resources resource gets the alternate resources that the work definition operation uses.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionResource-WorkDefinitionOperationAlternateResource-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceAttachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceAttachment-item-response"
    }
}

Nested Schema : WorkDefinitionOperationResourceDFF

Type: array

Show Source

• Array of: object workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceDFF-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 : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationAlternateResource-item-response

Type: object

Show Source

• AssignedUnits: number
  Title: Units Assigned

  Read Only: true

  Number of resource units the application assigns to perform the operation.
• 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.
• 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 work definition operation alternate resource.
• EquipmentParameterFileName: string
  Read Only: true

  Maximum Length: 512

  Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.
• InverseUsageRate: number
  Title: Inverse Usage

  Read Only: true

  Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriorityRanking: number
  Title: Priority

  Read Only: true

  Ranking of the alternative resource to use instead of the primary resource.
• ProgramFileId: integer (int64)
  Read Only: true

  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: 255

  Value that uniquely identifies the document item that represents the program file.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

  Description of the resource.
• ResourceId: integer (int64)
  Title: Resource

  Read Only: true

  Value that uniquely identifies the production resource. It's a primary key that the application generates when it consumes the production resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 30

  Category of the resource. Values include Labor or Equipment.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure that the resource uses.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the resource uses.
• UsageRate: number
  Title: Usage

  Read Only: true

  Resource usage that the plant requires to make each unit of the item.
• WdOperationAlternateResourceId: integer (int64)
  Read Only: true

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

  Value that uniquely identifies the resource that the work definition operation consumes. It's a primary key that the application generates when it consumes the resource.

{
    "type":"object",
    "properties":{
        "AssignedUnits":{
            "title":"Units Assigned",
            "type":"number",
            "description":"Number of resource units the application assigns to perform the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "EquipmentParameterFileContent":{
            "type":"string",
            "description":"Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation alternate resource.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EquipmentParameterFileName":{
            "maxLength":512,
            "type":"string",
            "description":"Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InverseUsageRate":{
            "title":"Inverse Usage",
            "type":"number",
            "description":"Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriorityRanking":{
            "title":"Priority",
            "type":"number",
            "description":"Ranking of the alternative resource to use instead of the primary resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the document item that represents the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceId":{
            "title":"Resource",
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it consumes the production resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Category of the resource. Values include Labor or Equipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "UsageRate":{
            "title":"Usage",
            "type":"number",
            "description":"Resource usage that the plant requires to make each unit of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WdOperationAlternateResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternative resource of a work definition operation. It's a primary key that the application generates when it creates the alternative resource of a work definition operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WdOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that the work definition operation consumes. It's a primary key that the application generates when it consumes the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

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

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

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

  The URI of the file.
• 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• 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

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

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

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

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 : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationResourceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Country Specific

  Maximum Length: 80

  Country Specific
• __FLEX_Context_DisplayValue: string
  Title: Country Specific

  Country Specific
• Discriminator: string
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "Discriminator":{
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "WdOperationResourceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Country Specific",
            "maxLength":80,
            "type":"string",
            "description":"Country Specific",
            "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":"Country Specific",
            "type":"string",
            "description":"Country Specific",
            "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

WorkDefinitionOperationAlternateResource

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionResource/{WorkDefinitionOperationResourceId}/child/WorkDefinitionOperationAlternateResource

Parameters:

• WorkDefinitionId: $request.path.WorkDefinitionId
• WorkDefinitionOperationResourceId2: $request.path.WorkDefinitionOperationResourceId2

The Alternate Resources resource gets the alternate resources that the work definition operation uses.

WorkDefinitionOperationResourceAttachment

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionResource/{WorkDefinitionOperationResourceId}/child/WorkDefinitionOperationResourceAttachment

Parameters:

• WorkDefinitionId: $request.path.WorkDefinitionId
• WorkDefinitionOperationResourceId2: $request.path.WorkDefinitionOperationResourceId2

The attachments resource is used to view, create, and update attachments.

WorkDefinitionOperationResourceDFF

Operation: /fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionResource/{WorkDefinitionOperationResourceId}/child/WorkDefinitionOperationResourceDFF

Parameters:

• WorkDefinitionId: $request.path.WorkDefinitionId
• WorkDefinitionOperationResourceId2: $request.path.WorkDefinitionOperationResourceId2

Back to Top

Examples

This example describes how to get one resource.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/WorkDefinitionId/child/WorkDefinitionResource/WorkDefinitionOperationResourceId"

For example, the following command gets one resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionResource/300100546045412"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"OrganizationId": 207,
	"ResourceSequenceNumber": 10,
	"WorkDefinitionOperationResourceId": 300100546045412,
	"ResourceId": 300100110956118,
	"ResourceCode": "EngTwo",
	"ResourceName": "Engineer Two",
	"ResourceDescription": "MC Engineer Two",
	"ResourceType": "LABOR",
	"WorkAreaId": 300100110956116,
	"WorkAreaCode": "MFG_WA",
	"WorkAreaName": "MFG Workarea",
	"WorkAreaDescription": "MFG Cleaning Workarea",
	"WorkCenterId": 300100110956122,
	"WorkCenterCode": "MCNOCAL",
	"WorkCenterName": "MFG Cleaning",
	"WorkCenterDescription": "Citrus Sorting and Cleaning",
	"WorkDefinitionId": 300100546045347,
	"WorkDefinitionOperationId": 300100546045410,
	"OperationSequenceNumber": 10,
	"OperationName": "Cleaning and Sorting",
	"StandardOperationId": 300100110956176,
	"StandardOperationCode": "MCCLEANSYS",
	"PrincipalFlag": false,
	"UsageRate": 1,
	"BasisType": "1",
	"UOMCode": "Ea",
	"UnitOfMeasure": "Each",
	"ChargeType": "AUTOMATIC",
	"AssignedUnits": 1,
	"ResourceActivityCode": null,
	"ScheduledIndicator": "NO",
	"InverseUsageRate": 1,
	"CreatedBy": "MFG_QA",
	"CreationDate": "2021-02-25T22:38:42.612+00:00",
	"LastUpdateDate": "2021-02-25T22:39:56.146+00:00",
	"LastUpdatedBy": "MFG_QA",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionResource/300100546045412",
		"name": "WorkDefinitionResource",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionResource/300100546045412",
		"name": "WorkDefinitionResource",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347",
		"name": "workDefinitions",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionResource/300100546045412/child/WorkDefinitionOperationAlternateResource",
		"name": "WorkDefinitionOperationAlternateResource",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionResource/300100546045412/child/WorkDefinitionOperationResourceAttachment",
		"name": "WorkDefinitionOperationResourceAttachment",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/workDefinitions/300100546045347/child/WorkDefinitionResource/300100546045412/child/WorkDefinitionOperationResourceDFF",
		"name": "WorkDefinitionOperationResourceDFF",
		"kind": "collection"
	}
	]
}

Back to Top