Get all resources
get
/fscmRestApi/resources/11.13.18.05/productionResources
Request
Query Parameters
-
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:- EquipmentResourcesByInstance: Finds production resources according to attributes of the equipment resource.
Finder Variables:- AssetItemId; integer; Value that uniquely identifies the item associated with the asset in the maintenance organization.
- AssetItemNumber; string; Item number of the asset that identifies the equipment instance.
- AssetNumber; string; Unique asset number that identifies the equipment instance.
- EquipmentIdentifier; string; Abbreviation that identifies the equipment resource instance.
- EquipmentInstanceId; integer; Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
- OrganizationId; integer; Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
- PrimaryWorkCenterCode; string; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center assigned to this equipment instance.
- PrimaryWorkCenterId; integer; Abbreviation that identifies the primary work center.
- LaborResourcesByInstance: Finds production resources according to attributes of the labor resource.
Finder Variables:- FirstName; string; First name of the person.
- LaborIdentifier; string; Value that identifies the labor instance of the person.
- LaborInstanceId; integer; Labor instance of the person.
- LastName; string; Last name of the person.
- MiddleName; string; Middle name of the person.
- OrganizationId; integer; Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
- PartyId; integer; Value that identifies the party of the person.
- PersonName; string; The person name stored in Oracle Trading Community Architecture.
- PersonType; string; Type of person.
- PrimaryWorkCenterCode; string; Abbreviation that identifies the primary work center of the person.
- PrimaryWorkCenterId; integer; Value that identifies the primary work center of the person.
- PrimaryKey: Finds production resources.
Finder Variables:- ResourceId; integer; Value that uniquely identifies the production resource. The application generates this value when it creates the equipment resource instance. This attribute is required.
- ProductionResourcesChangedAfter: Finds production resources that changed after a specific date.
Finder Variables:- ChangedDate; string; Production resources that changed after a specific date.
- OrganizationId; integer; Date when the person changed the production resources.
- ResourceType; string; Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
- EquipmentResourcesByInstance: Finds production resources according to attributes of the equipment resource.
-
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:- AutomationEquipmentFlag; boolean; Contains one of the following values: true or false. If true, then the equipment performs operations automatically. If false, then the equipment requires manual intervention to perform an operation. The default value is false.
- CostedFlag; boolean; Contains one of the following values: true or false. If true, then consider resource costs in work order costing. If false, then don't consider these costs. The default value is false.
- DefaultExpenditureTypeId; integer; Value that uniquely identifies the expenditure type used for project-related transaction distributions. This attribute is associated with a feature that requires opt in.
- DefaultExpenditureTypeName; string; Name of the cost classification assigned to each expenditure item. Expenditure types are grouped into cost groups and revenue groups. This attribute is associated with a feature that requires opt in.
- InactiveDate; string; Date when the resource becomes inactive. If the date is not specified, the resource is considered active.
- OrganizationCode; string; Abbreviation that identifies the inventory organization.
- OrganizationId; integer; Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
- OrganizationName; string; Name of the inventory organization.
- ResourceClassCode; string; Abbreviation that identifies the class that groups production resources. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_CLASS.
- ResourceCode; string; Abbreviation that identifies the production resource.
- ResourceDescription; string; Description of the production resource.
- ResourceId; integer; Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
- ResourceName; string; Name of the production resource.
- ResourceType; string; Value that indicates the type of the production resource. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE.
- UOMCode; string; Abbreviation that identifies the unit of measure. The application uses this code for scheduling and for resource charge. To use this resource for scheduling, it must be part of a valid Time UOM class.
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : productionResources
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionResources-item-response
Type:
Show Source
object
-
AutomationEquipmentFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the equipment performs operations automatically. If false, then the equipment requires manual intervention to perform an operation. The default value is false. -
CostedFlag: boolean
Title:
Costing enabled
Maximum Length:1
Contains one of the following values: true or false. If true, then consider resource costs in work order costing. If false, then don't consider these costs. The default value is false. -
DefaultExpenditureTypeId: integer
(int64)
Title:
Default Expenditure Type
Value that uniquely identifies the expenditure type used for project-related transaction distributions. This attribute is associated with a feature that requires opt in. -
DefaultExpenditureTypeName: string
Title:
Expenditure Type
Maximum Length:240
Name of the cost classification assigned to each expenditure item. Expenditure types are grouped into cost groups and revenue groups. This attribute is associated with a feature that requires opt in. -
EquipmentInstance: array
Equipment Instances
Title:
Equipment Instances
The Equipment Instances resource manages instances of an equipment resource. -
InactiveDate: string
(date)
Title:
Inactive On
Date when the resource becomes inactive. If the date is not specified, the resource is considered active. -
LaborInstance: array
Labor Instances
Title:
Labor Instances
The Labor Instances resource manages instances of a labor resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
-
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory organization. -
ProgramFileName: array
Program File Names
Title:
Program File Names
The Program File Names resource manages the association of program files with automation equipment resources. -
ResourceClassCode: string
Title:
Class
Maximum Length:30
Abbreviation that identifies the class that groups production resources. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_CLASS. -
ResourceCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the production resource. -
ResourceDescription: string
Title:
Description
Maximum Length:240
Description of the production resource. -
ResourceDFF: array
Flexfields for Resources
Title:
Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that the production resource uses. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
-
ResourceName: string
Title:
Name
Maximum Length:80
Name of the production resource. -
ResourceType: string
Title:
Type
Maximum Length:30
Value that indicates the type of the production resource. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_TYPE. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Name of the unit of measure. -
UOMCode: string
Title:
Usage UOM
Maximum Length:3
Abbreviation that identifies the unit of measure. The application uses this code for scheduling and for resource charge. To use this resource for scheduling, it must be part of a valid Time UOM class.
Nested Schema : Equipment Instances
Type:
array
Title:
Equipment Instances
The Equipment Instances resource manages instances of an equipment resource.
Show Source
Nested Schema : Labor Instances
Type:
array
Title:
Labor Instances
The Labor Instances resource manages instances of a labor resource.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Program File Names
Type:
array
Title:
Program File Names
The Program File Names resource manages the association of program files with automation equipment resources.
Show Source
Nested Schema : Flexfields for Resources
Type:
array
Title:
Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that the production resource uses.
Show Source
Nested Schema : productionResources-EquipmentInstance-item-response
Type:
Show Source
object
-
AssetDescription: string
Read Only:
true
Maximum Length:240
Description of the asset that identifies the equipment instance. -
AssetId: integer
(int64)
Title:
Asset Number
Value that uniquely identifies the item associated with the asset in the maintenance organization. -
AssetItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the asset in the maintenance organization. -
AssetItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item associated with the asset in the maintenance organization. -
AssetItemNumber: string
Read Only:
true
Maximum Length:300
Item number of the asset that identifies the equipment instance. -
AssetNumber: string
Maximum Length:
80
Unique asset number that identifies the equipment instance. -
EquipmentIdentifier: string
Title:
Identifier
Maximum Length:80
Abbreviation that identifies the equipment resource instance. -
EquipmentInstanceDFF: array
Flexfields for Equipment Instances
Title:
Flexfields for Equipment Instances
The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
-
EquipmentInstanceName: string
Title:
Name
Maximum Length:120
Name of the equipment resource instance. -
InactiveDate: string
(date)
Title:
Inactive On
Date when the equipment instance becomes inactive. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization. -
PrimaryWorkCenterCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the primary work center. -
PrimaryWorkCenterId: integer
(int64)
Title:
Primary Work Center
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center that the application assigns to this equipment instance. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.
Nested Schema : Flexfields for Equipment Instances
Type:
array
Title:
Flexfields for Equipment Instances
The Flexfields for Equipment Instances resource manages descriptive flexfields that the equipment instances uses.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionResources-EquipmentInstance-EquipmentInstanceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for equipment instances. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for equipment instances. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment resource instance. It is a primary key that the application generates when it creates a equipment instance.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : productionResources-LaborInstance-item-response
Type:
Show Source
object
-
InactiveDate: string
(date)
Title:
Inactive On
Date when the labor instance becomes inactive. -
LaborIdentifier: string
Title:
Identifier
Maximum Length:30
Abbreviation that identifies the labor resource instance. -
LaborInstanceDFF: array
Flexfields for Labor Instances
Title:
Flexfields for Labor Instances
The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses. -
LaborInstanceId: integer
(int64)
Value that uniquely identifies the labor resource instance. It is a primary key that the application generates when it creates a labor instance.
-
LaborInstanceName: string
Title:
Name
Maximum Length:360
Name of the labor resource instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization. It is a primary key that the application generates when it creates an inventory organization.
-
PartyId: integer
(int64)
Title:
Registry ID
Value that identifies the party table in Oracle Trading Community Architecture. It is a foreign key. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:360
Person name stored in Oracle Trading Community Architecture. -
PersonType: string
Title:
Usage
Read Only:true
Maximum Length:30
Type of person, such as employee, contingent worker, partner contact, and so on. -
PrimaryWorkCenterCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the primary work center. -
PrimaryWorkCenterId: integer
(int64)
Title:
Primary Work Center
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center. This is the default work center assigned to this equipment instance. -
RegistryId: string
Title:
Registry ID
Maximum Length:30
Value that identifies the registry from the Oracle Trading Community Architecture. This attribute is a foreign key. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It is a primary key that the application generates when it creates a production resource.
Nested Schema : Flexfields for Labor Instances
Type:
array
Title:
Flexfields for Labor Instances
The Flexfields for Labor Instances resource manages descriptive flexfields that the labor instances uses.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionResources-LaborInstance-LaborInstanceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for labor instances. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for labor instances. -
LaborInstanceId: integer
(int64)
Value that uniquely identifies the labor resource instance. It's a primary key that the application generates when it creates a labor instance.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionResources-ProgramFileName-item-response
Type:
Show Source
object
-
CurrentRevision: string
Read Only:
true
Maximum Length:18
Current revision of the document item that represents the current revision of the program file. -
EquipmentProgramFileId: integer
(int64)
Value that uniquely identifies the program file's association with the equipment.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
-
ProgramFileId: integer
(int64)
Value that uniquely identifies the document item that represents the name of the program file used by the equipment.
-
ProgramFileName: string
Maximum Length:
300
Name of the document item that represents the name of the program file. -
ResourceCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionResources-ResourceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for resources. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for resources. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. You can use a flexfield with this production resource. A flexfield is a flexible data field that your organization can use to modify your implementation without having to write programming code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all production resources.
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/productionResources"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "OrganizationId" : 207, "OrganizationCode" : "M1", "OrganizationName" : "Tall Manufacturing", "ResourceId" : 300100071642898, "ResourceName" : "M-Assl2", "ResourceDescription" : "M-Assl2", "ResourceCode" : "M-Assl2", "ResourceType" : "LABOR", "UnitOfMeasure" : "HRS", "ResourceClassCode" : null, "CostedFlag" : true, "InactiveDate" : null }, { ... } ], ... }