Get one exception
get
/fscmRestApi/resources/11.13.18.05/productionExceptions/{ExceptionId}
Request
Path Parameters
-
ExceptionId(required): integer(int64)
Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to 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 : productionExceptions-item-response
Type:
Show Source
object
-
ExceptionDescription: string
Read Only:
true
Maximum Length:4000
Description of the exception. -
ExceptionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception. -
ExceptionNumber: string
Read Only:
true
Maximum Length:100
Number that identifies the exception. -
ExceptionType: string
Read Only:
true
Maximum Length:400
Value that indicates the type of the exception. -
ExpectedDowntimeInMinutes: integer
(int64)
Read Only:
true
Value of the expected downtime for the production activity as a result of the exception specified in minutes. -
ExpectedResolutionDate: string
(date-time)
Read Only:
true
Date when the exception is expected to be resolved. -
ImpactedOperation: array
Impacted Operations
Title:
Impacted Operations
The Impacted Operations resource manages the work order operations that an exception impacts. -
InventoryItemId: number
Read Only:
true
Value that uniquely identifies the item for an exception of type component. It is a primary key that the application generates when it creates an item. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item for an exception of type component. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Value that identifies the item for an exception of type component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object version number of the exception. -
OpenImpactedOperationCount: number
Read Only:
true
Number of work order operations impacted by the exception. -
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. -
ReportedBy: string
Read Only:
true
Maximum Length:64
Name of the user who reported the exception. -
ReportedDate: string
(date-time)
Read Only:
true
Date when the exception was reported. -
ResourceCode: string
Read Only:
true
Maximum Length:30
Value that identifies the resource for an exception of type resource. -
ResourceId: number
Read Only:
true
Value that identifies the resource for an exception of type resource. It is a primary key that the application generates when it creates a resource. -
ResourceInstanceCode: string
Read Only:
true
Maximum Length:80
Abbreviation that identifies the resource instance. -
ResourceInstanceId: number
Read Only:
true
Value that uniquely identifies the resource instance. It is a primary key that the application generates when it creates a resource instance. -
ResourceInstanceName: string
Read Only:
true
Maximum Length:360
Name of the resource instance. -
ResourceName: string
Read Only:
true
Maximum Length:120
Name of the resource for an exception of type resource. -
ResourceType: string
Read Only:
true
Maximum Length:30
Type of production resource. Values include Labor or Equipment. -
SeverityCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the severity of the exception. -
SeverityDescription: string
Read Only:
true
Maximum Length:240
Description of the severity of the exception. -
SeverityOrder: string
Read Only:
true
Maximum Length:80
Value that identifies the order of severity of the exception. -
SupportedEntityTypeId: integer
(int64)
Read Only:
true
Number that identifies the exception type. It is the primary key. -
WoExceptionStatus: string
Read Only:
true
Maximum Length:4000
Status of the production exception. -
WoOperationId: integer
Value that identifies the primary impacted work order operation of the exception. It is a primary key that the application generates when it creates a work order operation.
-
WorkAreaCode: string
Read Only:
true
Maximum Length:30
Value that identifies the work area for an exception of type work area. -
WorkAreaDescription: string
Read Only:
true
Maximum Length:240
Description of the work area for an exception of type work area. -
WorkAreaId: number
Read Only:
true
Value that identifies the work area for an exception of type work area. It is a primary key that the application generates when it creates a work area. -
WorkAreaName: string
Read Only:
true
Maximum Length:120
Name of the work area for an exception of type work area. -
WorkCenterCode: string
Read Only:
true
Maximum Length:30
Value that identifies the work center for an exception of type work center. -
WorkCenterDescription: string
Read Only:
true
Maximum Length:240
Description of the work center for an exception of type work center. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that identifies the work center for an exception of type work center. It is a primary key that the application generates when it creates a work center. -
WorkCenterName: string
Read Only:
true
Maximum Length:120
Name of the work center for an exception of type work center. -
WorkflowStatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the status of the exception. -
WorkflowStatusId: integer
(int64)
Read Only:
true
Value that uniquely identifies the status of the exception. -
WorkflowStatusMeaning: string
Read Only:
true
Maximum Length:200
Meaning of the status of the exception. -
WorkOrderId: integer
Value that identifies the primary impacted work order of the exception. It is a primary key that the application generates when it creates a work order.
Nested Schema : Impacted Operations
Type:
array
Title:
Impacted Operations
The Impacted Operations resource manages the work order operations that an exception impacts.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionExceptions-ImpactedOperation-item-response
Type:
Show Source
object
-
AffectedObjectId: integer
Read Only:
true
Value that identifies the impacted work order operation of the exception. It is a primary key that the application generates when a work order operation is added as an impacted operation to the exception. -
Description: string
Read Only:
true
Maximum Length:240
Description of the work order item that is impacted. -
ExceptionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the exception. It is a primary key that the application generates when it creates a exception. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Value of the work order item that is impacted. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Object version number of the work order operation that is impacted. -
OperationName: string
Read Only:
true
Maximum Length:120
Name of the impacted work order operation. -
OperationPlannedComplDate: string
(date-time)
Read Only:
true
Date when the impacted work order operation is expected to finish. -
OperationPlannedStartDate: string
(date-time)
Read Only:
true
Date when the impacted work order operation is expected to start. -
OperationSequenceNumber: number
Read Only:
true
Sequence number of the impacted operation in the work order. -
ProjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies the project associated with the work order. This attribute is associated with a feature that requires opt in. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Number that identifies the project associated with the work order. This attribute is associated with a feature that requires opt in. -
ReportedDate: string
(date-time)
Read Only:
true
Date when the application reported the impacted work order operation. -
StandardOperationCode: string
Read Only:
true
Maximum Length:30
Abbreviation of the work order operation that is impacted. -
StandardOperationName: string
Read Only:
true
Maximum Length:120
Name of the work order operation that is impacted. -
StatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the status of the operation of the impacted work order. -
StatusDescription: string
Read Only:
true
Maximum Length:80
Description of the status of the operation of the impacted work order. -
SupportedEntityTypeId: integer
(int64)
Read Only:
true
Value that identifies the exception type. It is the primary key. -
TaskId: integer
(int64)
Read Only:
true
Value that uniquely identifies the task associated with the work order. This attribute is associated with a feature that requires opt in. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Number that identifies the task associated with the work order. This attribute is associated with a feature that requires opt in. -
WoOperationId: integer
(int64)
Read Only:
true
Value that identifies the work order operation that is impacted. It is a primary key that the application generates when it creates a work order operation. -
WoOperationOrder: number
Read Only:
true
Number that identifies the sequence for the work order operation. This value determines the sequence to use when displaying the operations in the user interface. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the impacted work order of the exception. It is a primary key that the application generates when it creates a work order. -
WorkOrderNumber: string
Read Only:
true
Maximum Length:120
Value that identifies the impacted work order of the exception.
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.
Links
- ImpactedOperation
-
Operation: /fscmRestApi/resources/11.13.18.05/productionExceptions/{ExceptionId}/child/ImpactedOperationParameters:
- ExceptionId:
$request.path.ExceptionId
The Impacted Operations resource manages the work order operations that an exception impacts. - ExceptionId:
Examples
This example describes how to get one production exception.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/manufacturingApi/resources/version/productionExceptions/ExceptionId"
For example, the following command gets production exception 300100098612251:
curl -u username:password "https://servername/manufacturingApi/resources/version/productionExceptions/300100098612251"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ ""ExceptionId"" : 300100098612251, ""ExceptionNumber"" : ""56"", ""ExceptionType"" : ""Resource"", ""SeverityCode"" : ""ORA_CRITICAL"", ""SeverityOrder"" : ""1"", ""SeverityDescription"" : ""Critical"", ""ReportedBy"" : null, ""ReportedDate"" : null, ""ExpectedDowntimeInMinutes"" : null, ""ExpectedResolutionDate"" : null, ""ExceptionDescription"" : null, ""OrganizationId"" : 207, ""WorkflowStatusId"" : 101, ""WorkflowStatusCode"" : ""ORA_MFG_OPEN"", ""WorkflowStatusMeaning"" : ""Open"", ""SupportedEntityTypeId"" : 1003, ""ItemNumber"" : null, ""InventoryItemId"" : null, ""ItemDescription"" : null, ""ResourceId"" : 300100075229783, ""ResourceCode"" : ""RC-TAB-ROBOT1"", ""ResourceName"" : ""RC-TAB-ROBOT1"", ""WorkAreaId"" : null, ""WorkAreaCode"" : null, ""WorkAreaName"" : null, ""WorkAreaDescription"" : null, ""WorkCenterId"" : null, ""WorkCenterCode"" : null, ""WorkCenterName"" : null, ""WorkCenterDescription"" : null, ""OpenImpactedOperationCount"" : 1, ""WoExceptionStatus"" : null, ""ObjectVersionNumber"" : 1, ""WorkOrderId"" : null, ""WoOperationId"" : null }"