Get all resources

get

/fscmRestApi/resources/11.13.18.05/standardOperations/{StandardOperationId}/child/StandardOperationResource

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 standard operations according to the resource identifier as the primary key.
      Finder Variables:
      • StandardOperationResourceId; integer; Value that uniquely identifies the resource that the standard operation uses. Manufacturing generates this primary key when it creates the resource. This attribute is required.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AlternateResourcesExistFlag; boolean; Contains one of the following values: true or false. If true, then alternative resources are available. If false, then alternative resources are not available. This attribute does not have a default value.
    • BasisType; string; Indicates whether the resource usage is fixed (i.e. usage per lot produced) or variable (i.e. usage per item produced). A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
    • ChargeType; string; Indicates how the resource is charged during work execution. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE.
    • CostedFlag; boolean; Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then do not consider these costs. The default value is false.
    • EquipmentProfileCode; string; Abbreviation that identifies the equipment profile associated with the standard operations resource. This attribute is associated with a feature that requires opt in.
    • EquipmentProfileId; integer; Value that uniquely identifies the equipment profile associated with the standard operations resource. This attribute is associated with a feature that requires opt in.
    • InactiveDate; string; Date when the standard operation alternate resource isn't valid.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that the application enables 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 this resource is the principal resource among a group of simultaneous resources. If false, then this resource is not the principal resource. At least one of the simultaneous resources must be a principal resource. The default value is false.
    • ProfileId; integer; Value that uniquely identifies the job profile associated with the standard operation resource. This attribute is associated with a feature that requires opt in.
    • 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 creates the production resource.
    • ResourceName; string; Name of the 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; Value that indicates if this resource is scheduled or not. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_SCHEDULE.
    • StandardOperationCode; string; Abbreviation that identifies the standard operation.
    • StandardOperationId; integer; Value that uniquely identifies the standard operation. It is a primary key that the application generates when it creates the standard operation.
    • StandardOperationName; string; Name of the standard operation.
    • StandardOperationResourceId; integer; Value that uniquely identifies the standard operation resource. It is a primary key that the application generates when it creates the resource.
    • UsageRate; number; Resource usage 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.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : standardOperations-StandardOperationResource
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : standardOperations-StandardOperationResource-item-response
Type: object
Show Source
  • Read Only: true
    Contains one of the following values: true or false. If true, then alternative resources are available. If false, then alternative resources are not available. This attribute does not have a default value.
  • Title: Units Assigned
    Default Value: 1
    Number of resource units the application assigns to perform the operation.
  • Title: Basis
    Maximum Length: 30
    Default Value: 1
    Indicates whether the resource usage is fixed (i.e. usage per lot produced) or variable (i.e. usage per item produced). A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
  • Title: Charge Type
    Maximum Length: 30
    Indicates how the resource is charged during work execution. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE.
  • Title: Costing enabled
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then do not consider these costs. The default value is false.
  • Maximum Length: 255
    Abbreviation that identifies the equipment profile associated with the standard operations resource. This attribute is associated with a feature that requires opt in.
  • Title: Equipment Profile
    Value that uniquely identifies the equipment profile associated with the standard operations resource. This attribute is associated with a feature that requires opt in.
  • Title: Inactive On
    Read Only: true
    Date when the standard operation alternate resource isn't valid.
  • Title: Inverse Usage
    Default Value: 1
    Resource usage that the plant uses to make each unit of the item. This value is the inverse of the usage rate. The application uses this inverse value when the resource usage rate is a fraction, but the inverse of this rate is an integer.
  • Links
  • Read Only: true
    Value that uniquely identifies the inventory organization that the application enables for manufacturing. It is a primary key that the application generates when it creates the inventory organization.
  • Title: Principal
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then this resource is the principal resource among a group of simultaneous resources. If false, then this resource is not the principal resource. At least one of the simultaneous resources must be a principal resource. The default value is false.
  • Maximum Length: 255
    Abbreviation that identifies the job profile associated with the standard operation resource. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the job profile associated with the standard operation resource. This attribute is associated with a feature that requires opt in.
  • Title: Activity
    Maximum Length: 30
    Abbreviation that Indicates the activity this production resource is going to perform at this operation. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY.
  • Read Only: true
    Maximum Length: 255
    Indicates the name of the activity this production resource is going to perform at this operation. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_ACTIVITY.
  • Title: Resource Code
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the resource.
  • Title: Resource
    Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates the production resource.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Title: Sequence
    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.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the resource. Values include Labor or Equipment.
  • Title: Scheduled
    Maximum Length: 30
    Value that indicates if this resource is scheduled or not. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_SCHEDULE.
  • Alternative Resources
    Title: Alternative Resources
    The Alternative Resources resource manages alternative resources that the standard operation uses.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • Read Only: true
    Value that uniquely identifies the standard operation. It is a primary key that the application generates when it creates the standard operation.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the standard operation.
  • Attachments for Resources
    Title: Attachments for Resources
    The Attachments for Resources resource manages attachments that contain details about the standard operation resource.
  • Flexfields for Resources
    Title: Flexfields for Resources
    The Flexfields for Resources resource manages descriptive flexfields that contain details about the standard operation resource.
  • Read Only: true
    Value that uniquely identifies the standard operation resource. It is a primary key that the application generates when it creates the resource.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Usage
    Default Value: 1
    Resource usage that the plant requires to make each unit of the item.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center.
  • Title: Work Center
    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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
Nested Schema : Alternative Resources
Type: array
Title: Alternative Resources
The Alternative Resources resource manages alternative resources that the standard operation uses.
Show Source
Nested Schema : Attachments for Resources
Type: array
Title: Attachments for Resources
The Attachments for Resources resource manages attachments that contain details about the standard operation resource.
Show Source
Nested Schema : Flexfields for Resources
Type: array
Title: Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that contain details about the standard operation resource.
Show Source
Nested Schema : standardOperations-StandardOperationResource-StandardOperationAlternateResource-item-response
Type: object
Show Source
  • Title: Units Assigned
    Number of resource units the application assigns to perform the operation for the alternative resource.
  • Title: Costing enabled
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then do not consider these costs. The default value is false.
  • Title: Inactive On
    Read Only: true
    Date when the standard operation resource isn't valid.
  • Title: Inverse Usage
    Resource usage that the plant uses to make each unit of the item for the alternative resource. This value is the inverse of the usage rate. The application uses this inverse value when the usage rate for the alternative resource is a fraction, but the inverse of this rate is an integer.
  • Links
  • Title: Priority
    Priority ranking of the alternative resource to use in place of the primary resource.
  • Title: Alternate Resources
    Maximum Length: 30
    Abbreviation that identifies the alternative resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the alternative resource.
  • Title: Alternate Resource
    Value that uniquely identifies the alternative resource. It is a primary key that the application generates when it creates the alternative resource.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the alternative resource.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the alternative resource. Values include Labor or Equipment.
  • Read Only: true
    Value that uniquely identifies the alternative resource of a standard operation. It is a primary key that the application generates when it creates the alternative resource.
  • Read Only: true
    Value that uniquely identifies the resource that the standard operation uses. It is a primary key that the application generates when it creates the resource.
  • Read Only: true
    Maximum Length: 255
    Unit of measure that the alternate resource uses.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the alternate resource uses.
  • Title: Usage
    Resource usage that the plant requires to make each unit of the item for the alternative resource.
Nested Schema : standardOperations-StandardOperationResource-StandardOperationResourceAttachment-item-response
Type: object
Show Source
Nested Schema : standardOperations-StandardOperationResource-StandardOperationResourceDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all resources in one standard operation.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/standardOperations/StandardOperationId/child/StandardOperationResource"

For example, the following command gets all resources in standard operation 300100084274715:

curl -u username:password "https://servername/fscmRestApi/resources/version/standardOperations/300100084274715/child/StandardOperationResource?onlyData=true"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "OrganizationId" : 207,
  "ResourceSequenceNumber" : 10,
  "StandardOperationResourceId" : 300100084274717,
  "ResourceId" : 300100083871679,
  "ResourceCode" : "Drill_Machine1",
  "ResourceName" : "Drill_Machine1",
  "ResourceDescription" : "Drill_Machine1 (MVS)",
  "ResourceType" : "EQUIPMENT",
  "WorkAreaId" : 300100083871642,
  "WorkAreaName" : "Welding Shop",
  "WorkAreaCode" : "Welding Shop",
  "WorkAreaDescription" : "MVS Welding Shop Work Area",
  "WorkCenterId" : 300100083871647,
  "WorkCenterName" : "Line1",
  "WorkCenterCode" : "Line1",
  "WorkCenterDescription" : "MVS-Line1",
  "StandardOperationName" : "Drilling",
  "StandardOperationId" : 300100084274715,
  "StandardOperationCode" : "Drilling",
  "PrincipalFlag" : false,
  "UsageRate" : 1,
  "BasisType" : "1",
  "InverseUsageRate" : 1,
  "UOMCode" : "HRS",
  "UnitOfMeasure" : "HRS",
  "ChargeType" : "AUTOMATIC",
  "AssignedUnits" : 1,
  "ResourceActivityCode" : null,
  "ScheduledIndicator" : "YES",
  "AlternateResourcesExistFlag" : false
}
Back to Top