REST API for Oracle Fusion Cloud SCM

Get all operation resources

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Operations/{OperationsUniqID}/child/OperationResources

Request

Path Parameters

OperationsUniqID(required): string

This is the hash key of the attributes which make up the composite key--- PlanIdSecondary, RoutingSequenceIdSecondary, OrganizationIdSecondary, NewPlanIdSecondary, SimulationSetIdSecondary, PlanId, OperationSequenceId, RoutingSequenceId, OrganizationId, NewPlanId and SimulationSetId ---for the Operations resource and used to uniquely identify an instance of Operations. The client should not generate the hash key value. Instead, the client should query on the Operations collection resource with a filter on the primary key values in order to navigate to a specific instance of Operations.

For example: Operations?q=PlanIdSecondary=<value1>;RoutingSequenceIdSecondary=<value2>;OrganizationIdSecondary=<value3>;NewPlanIdSecondary=<value4>;SimulationSetIdSecondary=<value5>;PlanId=<value6>;OperationSequenceId=<value7>;RoutingSequenceId=<value8>;OrganizationId=<value9>;NewPlanId=<value10>;SimulationSetId=<value11>
SimulationSetId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
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 the operation resource using the primary key.
  Finder Variables
  - NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
  - NewPlanIdSecondary; integer; Value that uniquely identifies the new plan that the duplication process creates.
  - OperationSequenceId; integer; Value that uniquely identifies the operation sequence.
  - OperationSequenceIdSecondary; integer; Value that uniquely identifies the operation sequence.
  - OrganizationId; integer; Value that uniquely identifies the organization.
  - OrganizationIdSecondary; integer; Value that uniquely identifies the organization.
  - PlanId; integer; Value that uniquely identifies the plan.
  - PlanIdSecondary; integer; Value that uniquely identifies the plan.
  - Priority; integer; Priority; integer; of the operation resource.
  - ResourceId; integer; Value that uniquely identifies the operation resource.
  - ResourceSequence; integer; Number representing the order in which the resources are assigned in the same operation.
  - ResourceSequenceSecondary; integer; Number representing the order in which the resources are assigned in the same operation.
  - RoutingSequenceId; integer; Routing sequence identifier for the routing or the work definition.
  - RoutingSequenceIdSecondary; integer; Routing sequence identifier for the routing or the work definition.
  - SimulationSetId; integer; Value that uniquely identifies the simulation set.
  - SimulationSetIdSecondary; integer; Value that uniquely identifies the simulation set.
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:
- AlternateResource; string; Indicates whether the resource is an alternate, nonprimary resource. Value values are Yes and No.
- AssignedUnits; integer; Number of units assigned to a resource.
- Basis; string; Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.
- BasisCode; integer; Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.
- ChangeIndicatorFlag; boolean; Value that identifies whether the operation description has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
- LastUpdatedBy; string; Indicates the user who last updated the row.
- LastUpdatedDate; string; Indicates the date and time of the last update of the row.
- NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
- NewPlanIdSecondary; integer; Value that uniquely identifies the new plan that the duplication process creates.
- OperationSequenceId; integer; Unique identifier of the operation sequence.
- OperationSequenceIdSecondary; integer; Unique identifier of the operation sequence.
- OrganizationId; integer; Unique identifier of the organization.
- OrganizationIdSecondary; integer; Unique identifier of the organization.
- PlanId; integer; Value that uniquely identifies the plan.
- PlanIdSecondary; integer; Value that uniquely identifies the plan.
- PrimaryResource; string; Name of the primary resource for which a specific resource is an alternate.
- PrimaryResourceId; integer; Unique identifier of the primary resource for which a specific resource is an alternate.
- PrincipalResource; string; Indicates whether a resource is a main resource or not. Valid Values are Yes and No.
- Priority; integer; A numeric value indicating the priority of the object.
- Resource; string; Code used to identify a resource. For example, a resource can be a piece of equipment.
- ResourceCost; number; Cost associated with a resource.
- ResourceId; integer; Value that uniquely identifies the resource.
- ResourceSequence; integer; Number representing the order in which the resources are assigned in the same operation.
- ResourceSequenceSecondary; integer; Number representing the order in which the resources are assigned in the same operation.
- ResourceUOM; string; Unit of measure associated with the resource.
- RoutingSequenceId; integer; Routing sequence identifier for the routing or the work definition.
- RoutingSequenceIdSecondary; integer; Routing sequence identifier for the routing or the work definition.
- ScheduleType; string; Indicates whether the resource needs to be scheduled or not. Valid values are Yes and No.
- SimulationSetId; integer; Value that uniquely identifies the simulation set.
- SimulationSetIdSecondary; integer; Value that uniquely identifies the simulation set.
- Usage; number; Amount of a resource that's needed, usually expressed in hours.
- WorkArea; string; Name of the work area.
- WorkCenter; string; Work center name of 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: string

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version: string

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

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 : simulationSets-Operations-OperationResources

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/simulationSets-Operations-OperationResources-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object simulationSets-Operations-OperationResources-item-response

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

Type: object

Show Source

AlternateResource: string

Title: Alternate Resource

Read Only: true

Maximum Length: 255

Indicates whether the resource is an alternate, nonprimary resource. Value values are Yes and No.
AssignedUnits: integer

Title: Assigned Units

Number of units assigned to a resource.
Basis: string

Title: Basis

Read Only: true

Maximum Length: 255

Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.
BasisCode: integer

Title: Basis

Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.
ChangeIndicatorFlag: boolean

Read Only: true

Value that identifies whether the operation description has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

Indicates the user who last updated the row.
LastUpdatedDate: string (date-time)

Title: Last Updated Date

Read Only: true

Indicates the date and time of the last update of the row.
links: array Links

Title: Links

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

Value that uniquely identifies the new plan that the duplication process creates.
NewPlanIdSecondary: integer (int64)

Value that uniquely identifies the new plan that the duplication process creates.
OperationSequenceId: integer

Unique identifier of the operation sequence.
OperationSequenceIdSecondary: integer

Unique identifier of the operation sequence.
OrganizationId: integer (int64)

Unique identifier of the organization.
OrganizationIdSecondary: integer (int64)

Unique identifier of the organization.
PlanId: integer

Value that uniquely identifies the plan.
PlanIdSecondary: integer

Value that uniquely identifies the plan.
PrimaryResource: string

Title: Primary Resource

Maximum Length: 40

Name of the primary resource for which a specific resource is an alternate.
PrimaryResourceId: integer (int64)

Title: Primary Resource

Unique identifier of the primary resource for which a specific resource is an alternate.
PrincipalResource: string

Title: Principal Resource

Read Only: true

Maximum Length: 255

Indicates whether a resource is a main resource or not. Valid Values are Yes and No.
Priority: integer

Title: Priority

A numeric value indicating the priority of the object.
Resource: string

Title: Resource

Maximum Length: 72

Code used to identify a resource. For example, a resource can be a piece of equipment.
ResourceCost: number

Title: Resource Cost

Cost associated with a resource.
ResourceId: integer (int64)

Value that uniquely identifies the resource.
ResourceSequence: integer

Title: Resource Sequence

Number representing the order in which the resources are assigned in the same operation.
ResourceSequenceSecondary: integer (int64)

Number representing the order in which the resources are assigned in the same operation.
ResourceUOM: string

Title: Resource UOM

Read Only: true

Maximum Length: 4000

Unit of measure associated with the resource.
RoutingSequenceId: integer

Routing sequence identifier for the routing or the work definition.
RoutingSequenceIdSecondary: integer

Routing sequence identifier for the routing or the work definition.
ScheduleType: string

Title: Schedule Type

Maximum Length: 80

Indicates whether the resource needs to be scheduled or not. Valid values are Yes and No.
SimulationSetId: integer (int64)

Value that uniquely identifies the simulation set.
SimulationSetIdSecondary: integer (int64)

Value that uniquely identifies the simulation set.
Usage: number

Title: Usage

Amount of a resource that's needed, usually expressed in hours.
WorkArea: string

Title: Work Area

Maximum Length: 120

Name of the work area.
WorkCenter: string

Title: Work Center

Maximum Length: 120

Work center name of the resource.

{
    "type":"object",
    "properties":{
        "LastUpdatedDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCost":{
            "title":"Resource Cost",
            "type":"number",
            "description":"Cost associated with a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleType":{
            "title":"Schedule Type",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the resource needs to be scheduled or not. Valid values are Yes and No.",
            "nullable":false,
            "x-queryable":true
        },
        "RoutingSequenceId":{
            "type":"integer",
            "description":"Routing sequence identifier for the routing or the work definition.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoutingSequenceIdSecondary":{
            "type":"integer",
            "description":"Routing sequence identifier for the routing or the work definition.",
            "nullable":false,
            "x-queryable":true
        },
        "NewPlanIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the new plan that the duplication process creates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Basis":{
            "title":"Basis",
            "maxLength":255,
            "type":"string",
            "description":"Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrincipalResource":{
            "title":"Principal Resource",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether a resource is a main resource or not. Valid Values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenter":{
            "title":"Work Center",
            "maxLength":120,
            "type":"string",
            "description":"Work center name of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "NewPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new plan that the duplication process creates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryResource":{
            "title":"Primary Resource",
            "maxLength":40,
            "type":"string",
            "description":"Name of the primary resource for which a specific resource is an alternate.",
            "nullable":true,
            "x-queryable":true
        },
        "Usage":{
            "title":"Usage",
            "type":"number",
            "description":"Amount of a resource that's needed, usually expressed in hours.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationIdSecondary":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryResourceId":{
            "title":"Primary Resource",
            "type":"integer",
            "description":"Unique identifier of the primary resource for which a specific resource is an alternate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceSequenceSecondary":{
            "type":"integer",
            "description":"Number representing the order in which the resources are assigned in the same operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"A numeric value indicating the priority of the object.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "Resource":{
            "title":"Resource",
            "maxLength":72,
            "type":"string",
            "description":"Code used to identify a resource. For example, a resource can be a piece of equipment.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeIndicatorFlag":{
            "type":"boolean",
            "description":"Value that identifies whether the operation description has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanIdSecondary":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":false,
            "x-queryable":true
        },
        "OperationSequenceId":{
            "type":"integer",
            "description":"Unique identifier of the operation sequence.",
            "nullable":false,
            "x-queryable":true
        },
        "BasisCode":{
            "title":"Basis",
            "type":"integer",
            "description":"Identifies whether component item usage is based on the quantity of an item produced or for the entire lot.",
            "nullable":false,
            "x-queryable":true
        },
        "AlternateResource":{
            "title":"Alternate Resource",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the resource is an alternate, nonprimary resource. Value values are Yes and No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUnits":{
            "title":"Assigned Units",
            "type":"integer",
            "description":"Number of units assigned to a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceUOM":{
            "title":"Resource UOM",
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceSequence":{
            "title":"Resource Sequence",
            "type":"integer",
            "description":"Number representing the order in which the resources are assigned in the same operation.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkArea":{
            "title":"Work Area",
            "maxLength":120,
            "type":"string",
            "description":"Name of the work area.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceIdSecondary":{
            "type":"integer",
            "description":"Unique identifier of the operation sequence.",
            "nullable":false,
            "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 : 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."
        }
    }
}