Get one plan status
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/planStatus/{ExecutionId}
Request
Path Parameters
-
ExecutionId(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=
-
PlanId(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:
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 : productionSchedulingPlans-planStatus-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
CurrentRequest: integer
(int32)
Current request that's handled by the engine. This attribute will be reset to null on successful completion of the plan, otherwise it identifies the request that failed.
-
EndDate: string
(date-time)
Date and time when the plan execution session is no longer effective.
-
ErrorCode: integer
(int32)
Abbreviation that identifies the error that describes the reason of last request failure. Valid values include null, EnvironmentError: 0, DataError: 1, and SolveError: 2.
-
ExecutionId: integer
(int64)
Value that uniquely identifies the plan execution session in the engine.
-
ExecutionUser: string
Maximum Length:
64
User who launches the plan execution. -
JobId: integer
(int64)
Value that uniquely identifies the job to run the plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
planStatusDetails: array
Plan Status Details
Title:
Plan Status Details
The Plan Status Details resource manages the details of the different states of the schedule. -
StartDate: string
(date-time)
Date when the plan execution session is effective.
-
Status: integer
(int32)
Status of the overall execution of the plan. Valid values include PlanRunning: 0, PlanSucceeded: 1, and PlanFailed: 2.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Plan Status Details
Type:
array
Title:
Plan Status Details
The Plan Status Details resource manages the details of the different states of the schedule.
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 : productionSchedulingPlans-planStatus-planStatusDetails-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
EndDate: string
(date-time)
Date when the request handling is no longer effective.
-
ExecutionId: integer
(int64)
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Percentage: integer
(int32)
Percent of completeness of plan execution.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Request: integer
(int32)
Request handled by the engine. Valid values include OpenPlan: 1, ReopenPlan: 2, SolvePlan: 3, ReschedulePlan: 4, SavePlan: 5, ResetSavedPlan: 6, ClosePlan: 7, and AbortPlan: 8.
-
StartDate: string
(date-time)
Date when the request handling is effective.
-
Status: integer
(int32)
Status of the overall execution of the plan. Valid values include PlanRunning: 0, PlanSucceeded: 1, and PlanFailed: 2.
-
StepSequence: integer
(int32)
Number that identifies the sequence of the plan execution steps.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- planStatusDetails
-
Parameters:
- ExecutionId:
$request.path.ExecutionId
- PlanId:
$request.path.PlanId
The Plan Status Details resource manages the details of the different states of the schedule. - ExecutionId: