Get one resource
get
/fscmRestApi/resources/11.13.18.05/standardOperations/{StandardOperationId}/child/StandardOperationResource/{StandardOperationResourceId}
Request
Path Parameters
-
StandardOperationId(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=
-
StandardOperationResourceId(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 -
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: 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.
Back to TopResponse
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 : standardOperations-StandardOperationResource-item-response
Type:
Show Source
object-
AlternateResourcesExistFlag: boolean
Read Only:
trueContains one of the following values: true or false. If true, then alternative resources are available. If false, then alternative resources aren't available. This attribute doesn't have a default value. -
AssignedUnits: number
Title:
Units AssignedDefault Value:1Number of resource units the application assigns to perform the operation. -
BasisType: string
Title:
BasisMaximum Length:30Default Value:1Indicates 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
Title:
Charge TypeMaximum Length:30Indicates 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
Title:
Costing enabledRead Only:trueMaximum Length:1Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then don't consider these costs. The default value is false. -
EquipmentProfileCode: string
Maximum Length:
255Abbreviation that identifies the equipment profile associated with the standard operations resource. This attribute is associated with a feature that requires opt in. -
EquipmentProfileId: integer
(int64)
Title:
Equipment ProfileValue 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)
Title:
Inactive OnRead Only:trueDate when the standard operation resource isn't valid. -
InverseUsageRate: number
Title:
Inverse UsageDefault Value:1Resource 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: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory organization that the application enables for manufacturing. It's a primary key that the application generates when it creates the inventory organization. -
PrincipalFlag: boolean
Title:
PrincipalMaximum Length:1Contains 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 isn't the principal resource. At least one of the simultaneous resources must be a principal resource. The default value is false. -
ProfileCode: string
Maximum Length:
255Abbreviation that identifies the job profile associated with the standard operation resource. This attribute is associated with a feature that requires opt in. -
ProfileId: integer
(int64)
Value that uniquely identifies the job profile associated with the standard operation resource. This attribute is associated with a feature that requires opt in.
-
ResourceActivityCode: string
Title:
ActivityMaximum Length:30Abbreviation 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. -
ResourceActivityName: string
Read Only:
trueMaximum Length:255Indicates 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. -
ResourceCode: string
Title:
Resource CodeMaximum Length:30Abbreviation that identifies the resource. -
ResourceDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the resource. -
ResourceId: integer
(int64)
Title:
ResourceValue that uniquely identifies the production resource. It's a primary key that the application generates when it creates the production resource. -
ResourceName: string
Title:
NameRead Only:trueMaximum Length:80Name of the resource. -
ResourceSequenceNumber: number
Title:
SequenceNumber 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
Title:
TypeRead Only:trueMaximum Length:30Category of the resource. Values include Labor or Equipment. -
ScheduledIndicator: string
Title:
ScheduledMaximum Length:30Value that indicates if this resource is scheduled or not. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_SCHEDULE. -
StandardOperationAlternateResource: array
Alternative Resources
Title:
Alternative ResourcesThe Alternative Resources resource manages alternative resources that the standard operation uses. -
StandardOperationCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the standard operation. It's a primary key that the application generates when it creates the standard operation. -
StandardOperationName: string
Title:
NameRead Only:trueMaximum Length:120Name of the standard operation. -
StandardOperationResourceAttachment: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
StandardOperationResourceDFF: array
StandardOperationResourceDFF
-
StandardOperationResourceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the standard operation resource. It's a primary key that the application generates when it creates the resource. -
UnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure that the resource uses. -
UOMCode: string
Title:
UOMRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure that the resource uses. -
UsageRate: number
Title:
UsageDefault Value:1Resource usage that the plant requires to make each unit of the item. -
WorkAreaCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
NameRead Only:trueMaximum Length:80Name of the work area. -
WorkCenterCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the work center. -
WorkCenterId: integer
(int64)
Title:
Work CenterRead Only:trueValue that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
NameRead Only:trueMaximum Length:120Name of the work center.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Alternative Resources
Type:
arrayTitle:
Alternative ResourcesThe Alternative Resources resource manages alternative resources that the standard operation uses.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : standardOperations-StandardOperationResource-StandardOperationAlternateResource-item-response
Type:
Show Source
object-
AssignedUnits: number
Title:
Units AssignedNumber of resource units the application assigns to perform the operation for the alternative resource. -
CostedFlag: boolean
Title:
Costing enabledRead Only:trueMaximum Length:1Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then don't consider these costs. The default value is false. -
InactiveDate: string
(date)
Title:
Inactive OnRead Only:trueDate when the standard operation alternate resource isn't valid. -
InverseUsageRate: number
Title:
Inverse UsageResource 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: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriorityRanking: integer
Title:
PriorityPriority ranking of the alternative resource to use in place of the primary resource. -
ResourceCode: string
Title:
Alternate ResourcesMaximum Length:30Abbreviation that identifies the alternative resource. -
ResourceDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the alternative resource. -
ResourceId: integer
(int64)
Title:
Alternate ResourceValue that uniquely identifies the alternative resource. It's a primary key that the application generates when it creates the alternative resource. -
ResourceName: string
Title:
NameRead Only:trueMaximum Length:80Name of the alternative resource. -
ResourceType: string
Title:
TypeRead Only:trueMaximum Length:30Category of the alternative resource. Values include Labor or Equipment. -
StandardOperationAlternateResourceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the alternative resource of a standard operation. It's a primary key that the application generates when it creates the alternative resource. -
StandardOperationResourceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the resource that the standard operation uses. It's a primary key that the application generates when it creates the resource. -
UnitOfMeasure: string
Read Only:
trueMaximum Length:255Unit of measure that the alternate resource uses. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure that the alternate resource uses. -
UsageRate: number
Title:
UsageResource usage that the plant requires to make each unit of the item for the alternative resource.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : standardOperations-StandardOperationResource-StandardOperationResourceAttachment-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : standardOperations-StandardOperationResource-StandardOperationResourceDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
Discriminator: string
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StdOperationResourceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- StandardOperationAlternateResource
-
Parameters:
- StandardOperationId:
$request.path.StandardOperationId - StandardOperationResourceId:
$request.path.StandardOperationResourceId
The Alternative Resources resource manages alternative resources that the standard operation uses. - StandardOperationId:
- StandardOperationResourceAttachment
-
Parameters:
- StandardOperationId:
$request.path.StandardOperationId - StandardOperationResourceId:
$request.path.StandardOperationResourceId
The attachments resource is used to view, create, and update attachments. - StandardOperationId:
- StandardOperationResourceDFF
-
Parameters:
- StandardOperationId:
$request.path.StandardOperationId - StandardOperationResourceId:
$request.path.StandardOperationResourceId
- StandardOperationId: