Jump to

• Request
• Response

GET action not supported

get

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

Request

Path Parameters

• alternateResourcesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Alternate Resources resource and used to uniquely identify an instance of Alternate Resources. The client should not generate the hash key value. Instead, the client should query on the Alternate Resources collection resource in order to navigate to a specific instance of Alternate Resources to get the hash key.
• 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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  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-alternateResources-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that represents the resource code of the resource for which this alternate resource is applicable.",
            "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 with 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
        },
        "InverseUsage":{
            "type":"number",
            "description":"Value that indicates the inverse alternate resource usage rate.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"225",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitsAssigned":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameters flat file associated with the work definition operation alternate resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"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.",
            "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:\n1 (VARIABLE), 2 (FIXED). If the value is not specified during the CREATE action, the default value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRate":{
            "type":"number",
            "description":"The alternate resource usage rate to yield one unit of product. The default value is from the primary resource.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorityRanking":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AlternateResourceCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the alternate resource.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the execution sequence of the operation. 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 alternate 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