Create one alternate resource
post
/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/alternateResources
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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Value that specifies the desired action to perform on the alternate resource of a work definition operation resource. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute. -
AlternateResourceCode: string
Maximum Length:
30
Value that indicates the alternate resource. -
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), 2 (FIXED). If the value is not specified during the CREATE action, the default value is 1. -
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 alternate resource.
-
EquipmentParameterFileName: string
Maximum Length:
512
Name of the equipment parameters flat file associated with the work definition operation alternate resource. -
ErrorMessageNames: string
Maximum Length:
225
Names of the error messages that occurred when processing the alternate resources of a 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 message, if any, that occurred when processing the alternate resources of a 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. -
InverseUsage: number
Value that indicates the inverse alternate resource usage rate.
-
OperationSequenceNumber: number
Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
-
PriorityRanking: number
Value that indicates the order of priority. Oracle Planning Cloud uses this information to select the appropriate alternate resource. A valid value must be a positive whole number.
-
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 with the automation equipment resource in the resource definition. -
ResourceCode: string
Maximum Length:
30
Value that represents the resource code of the resource for which this alternate resource is applicable. -
ResourceSequenceNumber: number
Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
-
UnitsAssigned: number
Value that indicates the number of alternate resources assigned to this operation. A valid value must be a positive whole number. The default value is from the primary resource.
-
UsageRate: number
The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.
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.
Root Schema : workDefinitionRequests-workDefinitionHeaders-alternateResources-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Value that specifies the desired action to perform on the alternate resource of a work definition operation resource. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute. -
AlternateResourceCode: string
Maximum Length:
30
Value that indicates the alternate resource. -
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), 2 (FIXED). If the value is not specified during the CREATE action, the default value is 1. -
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 alternate resource.
-
EquipmentParameterFileName: string
Maximum Length:
512
Name of the equipment parameters flat file associated with the work definition operation alternate resource. -
ErrorMessageNames: string
Maximum Length:
225
Names of the error messages that occurred when processing the alternate resources of a 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 message, if any, that occurred when processing the alternate resources of a 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. -
InverseUsage: number
Value that indicates the inverse alternate resource usage rate.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationSequenceNumber: number
Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
-
PriorityRanking: number
Value that indicates the order of priority. Oracle Planning Cloud uses this information to select the appropriate alternate resource. A valid value must be a positive whole number.
-
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 with the automation equipment resource in the resource definition. -
ResourceCode: string
Maximum Length:
30
Value that represents the resource code of the resource for which this alternate resource is applicable. -
ResourceSequenceNumber: number
Number that defines the sequence of the resource used in the operation. A valid value must be a positive whole number.
-
UnitsAssigned: number
Value that indicates the number of alternate resources assigned to this operation. A valid value must be a positive whole number. The default value is from the primary resource.
-
UsageRate: number
The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.