Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/resources

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• 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
    Finder Variables:
• 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:
  

  • ActionCode; string; Value that specifies the desired action to perform on the resource of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
  • AssignedUnits; number; Value that indicates the number of resources assigned to this operation. A valid value must be a positive whole number. The default value is 1 if a value is not specified during the CREATE action.
  • BasisType; string; Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE) or 2 (FIXED). The default value is 1 if a value is not specified during the CREATE action.
  • ChargeType; string; Contains one of the following values: AUTOMATIC and MANUAL. If AUTOMATIC, then the resource is charged automatically during work execution. If MANUAL, then the resource is charged manually during work execution. The default value is AUTOMATIC.
  • EquipmentParameterFileName; string; Name of the equipment parameters flat file associated with the work definition operation resource.
  • EquipmentProfileCode; string; Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
  • ErrorMessageNames; string; Names of the error messages that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
  • ErrorMessages; string; Text of the error messages, if any, that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
  • InverseUsageRate; number; Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.
  • OperationSequenceNumber; number; Number that defines the sequence of operation execution. A valid value must be a positive whole number.
  • 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. When two or more resources are running in parallel; for example, simultaneous resources that have the same sequence number, only one of them must be marked as the principal or the primary resource. Planning will error if the principal resource is not available when checking for capacity. If false, then this resource is not the principal resource. The default value is false.
  • ProfileCode; string; Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
  • ProgramFileName; string; The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated to the automation equipment resource in the resource definition.
  • ResourceActivityCode; string; Value that indicates the activity this production resource is going to perform at this operation. Valid values include ORA_RUN, ORA_SETUP, and ORA_TEAR_DOWN. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY. The default value is ORA_RUN.
  • ResourceCode; string; Value that indicates the resource assigned to the operation.
  • ResourceSequenceNumber; number; Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
  • ScheduledIndicator; string; Contains one of the following values: YES and NO. If YES, then resource is scheduled. If NO, then resource is not scheduled. The default value is NO if no value is specified during the CREATE action.
  • UsageRate; number; Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.
• 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 : workDefinitionRequests-workDefinitionHeaders-resources

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/workDefinitionRequests-workDefinitionHeaders-resources-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workDefinitionRequests-workDefinitionHeaders-resources-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/workDefinitionRequests-workDefinitionHeaders-resources-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 : workDefinitionRequests-workDefinitionHeaders-resources-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the resource of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.
• AssignedUnits: number
  Value that indicates the number of resources assigned to this operation. A valid value must be a positive whole number. The default value is 1 if a value is not specified during the CREATE action.
• BasisType: string
  Maximum Length: 30

  Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE) or 2 (FIXED). The default value is 1 if a value is not specified during the CREATE action.
• ChargeType: string
  Maximum Length: 30

  Default Value: AUTOMATIC

  Contains one of the following values: AUTOMATIC and MANUAL. If AUTOMATIC, then the resource is charged automatically during work execution. If MANUAL, then the resource is charged manually during work execution. The default value is AUTOMATIC.
• EquipmentParameterFileContent: string (byte)
  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
  Maximum Length: 512

  Name of the equipment parameters flat file associated with the work definition operation resource.
• EquipmentProfileCode: string
  Maximum Length: 30

  Abbreviation that identifies the equipment profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error messages, if any, that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• InverseUsageRate: number
  Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceNumber: number
  Number that defines the sequence of operation execution. A valid value must be a positive whole number.
• PrincipalFlag: boolean
  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. When two or more resources are running in parallel; for example, simultaneous resources that have the same sequence number, only one of them must be marked as the principal or the primary resource. Planning will error if the principal resource is not available when checking for capacity. If false, then this resource is not the principal resource. The default value is false.
• ProfileCode: string
  Maximum Length: 30

  Abbreviation that identifies the job profile associated with the work definition operation resource. This attribute is associated with a feature that requires opt in.
• ProgramFileName: string
  Maximum Length: 300

  The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated to the automation equipment resource in the resource definition.
• ResourceActivityCode: string
  Maximum Length: 30

  Value that indicates the activity this production resource is going to perform at this operation. Valid values include ORA_RUN, ORA_SETUP, and ORA_TEAR_DOWN. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY. The default value is ORA_RUN.
• ResourceCode: string
  Maximum Length: 30

  Value that indicates the resource assigned to the operation.
• ResourceSequenceNumber: number
  Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
• ScheduledIndicator: string
  Maximum Length: 30

  Default Value: NO

  Contains one of the following values: YES and NO. If YES, then resource is scheduled. If NO, then resource is not scheduled. The default value is NO if no value is specified during the CREATE action.
• UsageRate: number
  Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the resource assigned to the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseUsageRate":{
            "type":"number",
            "description":"Value that indicates the inverse resource usage rate. Don't specify this attribute if a value is specified for the UsageRate attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceActivityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the activity this production resource is going to perform at this operation. Valid values include ORA_RUN, ORA_SETUP, and ORA_TEAR_DOWN. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY. The default value is ORA_RUN.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":"300",
            "type":"string",
            "description":"The name of the program file to be associated with an automation equipment resource in the work definition. This program file name must be associated to the automation equipment resource in the resource definition.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentProfileCode":{
            "maxLength":"30",
            "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,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the desired action to perform on the resource of a work definition operation. Valid values include CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileCode":{
            "maxLength":"30",
            "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,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameters flat file associated with the work definition operation resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error messages, if any, that occurred when processing the work definition operation resource. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledIndicator":{
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values: YES and NO. If YES, then resource is scheduled. If NO, then resource is not scheduled. The default value is NO if no value is specified during the CREATE action.",
            "nullable":true,
            "default":"NO",
            "x-queryable":true
        },
        "AssignedUnits":{
            "type":"number",
            "description":"Value that indicates the number of resources assigned to this operation. A valid value must be a positive whole number. The default value is 1 if a value is not specified during the CREATE action.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates whether the resource usage is fixed, such as usage per lot produced, or variable, such as usage per item produced. Valid values are: 1 (VARIABLE) or 2 (FIXED). The default value is 1 if a value is not specified during the CREATE action.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRate":{
            "type":"number",
            "description":"Resource usage rate to yield one unit of product. The default value is 1 if a value is not specified during the CREATE action.",
            "nullable":true,
            "x-queryable":true
        },
        "PrincipalFlag":{
            "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. When two or more resources are running in parallel; for example, simultaneous resources that have the same sequence number, only one of them must be marked as the principal or the primary resource. Planning will error if the principal resource is not available when checking for capacity. If false, then this resource is not the principal resource. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeType":{
            "maxLength":"30",
            "type":"string",
            "description":"Contains one of the following values: AUTOMATIC and MANUAL. If AUTOMATIC, then the resource is charged automatically during work execution. If MANUAL, then the resource is charged manually during work execution. The default value is AUTOMATIC.",
            "nullable":true,
            "default":"AUTOMATIC",
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that defines the sequence of operation execution. A valid value must be a positive whole number.",
            "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,
            "x-queryable":false
        },
        "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 : 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."
        }
    }
}

Back to Top