Jump to

• Request
• Response

Get all resources

get

/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOperation/{WorkDefinitionOperationId}/child/WorkDefinitionOperationResource

Request

Path Parameters

• WorkDefinitionId(required): integer(int64)
  Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
• WorkDefinitionOperationId(required): integer(int64)
  Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds resources for the work definition operation according to the resource identifier as the primary key.
    Finder Variables:
    • WorkDefinitionOperationResourceId; integer; Value that uniquely identifies the resource for the work definition operation. It is the primary key. This attribute is required.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BasisType; string; Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. This attribute does not have a default value.
  • ChargeType; string; 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 does not have a default value.
  • CreatedBy; string; User who created this record.
  • CreationDate; string; Date and time when the record was created.
  • CurrentRevision; string; Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
  • EquipmentParameterFileName; string; Name of the equipment parameter's flat file associated with the work definition operation's resource.
  • EquipmentProfileId; integer; 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; Rate that indicates the inverse resource usage.
  • LastUpdateDate; string; Date when record was most recently updated.
  • LastUpdatedBy; string; User who most recently updated the record.
  • OperationName; string; Name of the operation.
  • OperationSequenceNumber; number; Number that indicates the sequence to use when performing the work order operations.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is a primary key that the application generates when it creates the inventory organization.
  • PrincipalFlag; boolean; 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 is not the principal resource. This attribute does not have a default value.
  • ProfileId; integer; 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; 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; Value that uniquely identifies the document item that represents the program file.
  • ResourceCode; string; Abbreviation that identifies the resource.
  • ResourceId; integer; Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource.
  • ResourceSequenceNumber; number; 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; Category of the resource. Values include Labor or Equipment.
  • ScheduledIndicator; string; 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 does not schedule the resource and the application sets the start date equal to the completion date. This attribute does not have a default value.
  • StandardOperationCode; string; Abbreviation that identifies the standard operation.
  • StandardOperationId; integer; Value that uniquely identifies the standard operation that the work definition operation references. It is a primary key that the application generates when it creates the standard operation.
  • UsageRate; number; Rate of the resource that the plant requires to make each unit of the item.
  • WorkAreaCode; string; Abbreviation that identifies the work area.
  • WorkAreaId; integer; Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.
  • WorkCenterCode; string; Abbreviation that identifies the work center.
  • WorkCenterId; integer; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.
  • WorkDefinitionId; integer; Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
  • WorkDefinitionOperationId; integer; Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.
  • WorkDefinitionOperationResourceId; integer; Value that uniquely identifies the resource for the work definition operation. It is a primary key that the application generates when it creates the resource.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-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 does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. This attribute does not 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 does not 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 is 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 is not the principal resource. This attribute does not 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 is 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 does not schedule the resource and the application sets the start date equal to the completion date. This attribute does not 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 is 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 is 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 is a primary key that the application generates when it creates the work center.
• WorkCenterName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

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

  Value that uniquely identifies the work definition. It is 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 is a primary key that the application generates when it creates the work definition operation.
• WorkDefinitionOperationResourceAttachment: array Attachments for Resources
  Title: Attachments for Resources

  The Attachments for Resources resource gets the attachments that contain details about the resource.
• WorkDefinitionOperationResourceDFF: array Flexfields for Resources
  Title: Flexfields for Resources

  The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses.
• WorkDefinitionOperationResourceId: integer (int64)
  Read Only: true

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

{
    "type":"object",
    "properties":{
        "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
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceActivityCode":{
            "title":"Activity",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the resource activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition. It is 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
        },
        "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
        },
        "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
        },
        "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 is not the principal resource. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area. It is 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
        },
        "WorkDefinitionOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation. It is 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
        },
        "WorkCenterCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "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
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "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
        },
        "WorkDefinitionOperationResourceDFF":{
            "title":"Flexfields for Resources",
            "type":"array",
            "description":"The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "WorkDefinitionOperationResourceAttachment":{
            "title":"Attachments for Resources",
            "type":"array",
            "description":"The Attachments for Resources resource gets the attachments that contain details about the resource.",
            "items":{
                "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceAttachment-item-response"
            }
        },
        "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-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationAlternateResource-item-response"
            }
        },
        "WorkAreaCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledIndicator":{
            "title":"Scheduled",
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling does not schedule the resource and the application sets the start date equal to the completion date. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It is 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
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation that the work definition operation references. It is 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
        },
        "ProgramFileName":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the document item that represents the program file.",
            "nullable":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
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that the application enabled for manufacturing. It is 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
        },
        "WorkAreaName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work area.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkDefinitionOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource for the work definition operation. It is 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
        },
        "OperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the operation.",
            "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
        },
        "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
        },
        "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
        },
        "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 does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "default":"2",
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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 does not have a default value.",
            "nullable":false,
            "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
        }
    }
}

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-WorkDefinitionOperation-WorkDefinitionOperationResource-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-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationAlternateResource-item-response"
    }
}

Nested Schema : Attachments for Resources

Type: array

Title: Attachments for Resources

The Attachments for Resources resource gets the attachments that contain details about the resource.

Show Source

• Array of: object workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceAttachment-item-response

{
    "title":"Attachments for Resources",
    "type":"array",
    "description":"The Attachments for Resources resource gets the attachments that contain details about the resource.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceAttachment-item-response"
    }
}

Nested Schema : Flexfields for Resources

Type: array

Title: Flexfields for Resources

The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses.

Show Source

• Array of: object workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceDFF-item-response

{
    "title":"Flexfields for Resources",
    "type":"array",
    "description":"The Flexfields for Resources resource gets the descriptive flexfields that contain details about the resource that the work definition operation uses.",
    "items":{
        "$ref":"#/components/schemas/workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-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-WorkDefinitionOperation-WorkDefinitionOperationResource-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 is 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 is 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 is a primary key that the application generates when it consumes the resource.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":false,
            "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
        },
        "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"
            }
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramFileName":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the document item that represents the program file.",
            "nullable":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
        },
        "CurrentRevision":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "ResourceId":{
            "title":"Resource",
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It is 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
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WdOperationAlternateResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternative resource of a work definition operation. It is 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
        },
        "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
        },
        "WdOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that the work definition operation consumes. It is 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
        }
    }
}

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-WorkDefinitionOperation-WorkDefinitionOperationResource-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

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

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

  Date when the contents in the attachment are no longer available.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

  Date and time when the user most recently updated the document that is attached to the work definition operation output.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who updated the document that is attached to the work definition operation output.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document that is attached to the work definition.
• links: array Links
  Title: Links

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

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

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

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-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationResourceDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Country Specific

  Maximum Length: 80

  Descriptive flexfield context name for work definition operation resources.
• __FLEX_Context_DisplayValue: string
  Title: Country Specific
• Discriminator: string
  This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• WdOperationResourceId: integer (int64)
  Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Country Specific",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "Discriminator":{
            "type":"string",
            "description":"This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "WdOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.",
            "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":"Descriptive flexfield context name for work definition operation resources.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top