Get one guided task
get
/fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks/{guidedTaskId}
Request
Path Parameters
-
guidedTaskId(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:
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 : productManagementGuidedTasks-item-response
Type:
Show Source
object
-
createdBy: string
Read Only:
true
Maximum Length:64
User who created the guided task. -
description: string
Maximum Length:
1000
Name of a description for a translated guided task. -
globalContext: string
Maximum Length:
3000
Value that identifies the global context for a guided task. -
guidedTaskId: integer
(int64)
Value that uniquely identifies the guided task.
-
guidedTaskInstances: array
Guided Task Instances
Title:
Guided Task Instances
Guided task instances provide a configured task process that you can implement such as the replacement of a component that's no longer available or the replacement of a component with a substitute due to a shortage in current stock. -
guidedTaskSteps: array
Guided Task Steps
Title:
Guided Task Steps
Steps that are used as building blocks to construct a guided task process. You can assemble a guided task step using steps such as Review and Submit or Replacement Component Search. -
headerObject: string
Maximum Length:
150
Value that identifies the header object for a guided task. -
headerObjectValue: string
Read Only:
true
Maximum Length:255
Value that identifies the meaning of header object for a guided task. -
image: string
(byte)
Image for a guided task.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
name: string
Maximum Length:
150
Name of a translated guided task. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Value that uniquely identifies the object version of the guided task. This value is set to 1 when the guided task is created and it's incremented every time the guided task is updated. -
status: string
Maximum Length:
100
Status for a guided task. -
statusValue: string
Read Only:
true
Maximum Length:255
Value that identifies the meaning of status for a guided task. -
timeCreated: string
(date-time)
Read Only:
true
Date and time when the user created the guided task. -
timeUpdated: string
(date-time)
Read Only:
true
Date when the user most recently updated the guided task. -
updatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the guided task. -
visibility: string
Maximum Length:
150
Value that identifies the visibility for a guided task.
Nested Schema : Guided Task Instances
Type:
array
Title:
Guided Task Instances
Guided task instances provide a configured task process that you can implement such as the replacement of a component that's no longer available or the replacement of a component with a substitute due to a shortage in current stock.
Show Source
Nested Schema : Guided Task Steps
Type:
array
Title:
Guided Task Steps
Steps that are used as building blocks to construct a guided task process. You can assemble a guided task step using steps such as Review and Submit or Replacement Component Search.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productManagementGuidedTasks-guidedTaskInstances-item-response
Type:
Show Source
object
-
createdBy: string
Read Only:
true
Maximum Length:64
User who created the guided task instance. -
description: string
Maximum Length:
1000
Description of the guided task instance. -
instanceId: integer
(int64)
Value that uniquely identifies the guided task instance.
-
jobId: integer
(int64)
Value that uniquely identifies the guided task instance job.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
metadata: string
Maximum Length:
3000
Value that identifies the metadata for a guided task instance. -
name: string
Maximum Length:
150
Name of the guided task instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Value that uniquely identifies the object version of the guided instance. This value is set to 1 when the guided task instance is created and it's incremented every time the guided task instance is updated. -
status: string
Maximum Length:
30
Value that identifies the status of a guided task instance. -
statusValue: string
Read Only:
true
Maximum Length:255
Value that identifies the status for a guided task instance. -
taskConfigMetadata: string
(byte)
Value that identifies the metadata for a guided task instance.
-
timeCreated: string
(date-time)
Read Only:
true
Date and time when the user created the guided task instance. -
timeUpdated: string
(date-time)
Read Only:
true
Date when the user most recently updated the guided task instance. -
updatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the guided task 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 : productManagementGuidedTasks-guidedTaskSteps-item-response
Type:
Show Source
object
-
createdBy: string
Read Only:
true
Maximum Length:64
User who created the guided task step. -
description: string
Maximum Length:
1000
Description of the translated guided task step. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
name: string
Maximum Length:
150
Name of the guided task step. -
objectSearchViews: array
Object Search Views
Title:
Object Search Views
Object views contain information that support the configuration of a search for an object. For example, you can configure the object view to only search for items within a certain organization or only search for items that have an Active status. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Value that uniquely identifies the object version of the guided task step. This value is set to 1 when the guided task step is created and it's incremented every time the guided task step is updated. -
stepId: integer
(int64)
Value that uniquely identifies the guided task step.
-
stepNumber: integer
(int64)
Value that identifies the number for a guided task step.
-
stepObject: string
Maximum Length:
150
Value that identifies the step object for a guided task step. -
stepObjectValue: string
Read Only:
true
Maximum Length:255
Value that identifies the meaning of step object for a guided task step. -
stepSearchViewIds: string
Maximum Length:
500
Value that uniquely identifies the step search view. -
stepType: string
Maximum Length:
150
Value that identifies the step type for a guided task step. -
stepTypeValue: string
Read Only:
true
Maximum Length:255
Value that identifies the meaning of step type for a guided task step. -
timeCreated: string
(date-time)
Read Only:
true
Date and time when the user created the guided task step. -
timeUpdated: string
(date-time)
Read Only:
true
Date when the user most recently updated the guided task step. -
updatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the guided task step.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Object Search Views
Type:
array
Title:
Object Search Views
Object views contain information that support the configuration of a search for an object. For example, you can configure the object view to only search for items within a certain organization or only search for items that have an Active status.
Show Source
Nested Schema : productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-response
Type:
Show Source
object
-
createdBy: string
Read Only:
true
Maximum Length:64
User who created the guided task object search view. -
hint: string
Maximum Length:
150
Value that identifies the hint for an object search view. -
label: string
Maximum Length:
150
Label for an object search view. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
name: string
Maximum Length:
150
Translated name of the object search view. -
object: string
Maximum Length:
150
Name of the object search view. -
objectValue: string
Read Only:
true
Maximum Length:255
Value that identifies the meaning of object for an object search view. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
This value is set to 1 when the object search view is created and it's incremented every time the object search view is updated. -
searchConfig: string
Maximum Length:
3000
Value that identifies the search configuration for an object search view. -
searchViewId: integer
(int64)
Value that uniquely identifies the object search view.
-
timeCreated: string
(date-time)
Read Only:
true
Date and time when the user created the guided task object search view. -
timeUpdated: string
(date-time)
Read Only:
true
Date when the user most recently updated the guided task object search view. -
updatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the guided task object search view.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- guidedTaskInstances
-
Parameters:
- guidedTaskId:
$request.path.guidedTaskId
Guided task instances provide a configured task process that you can implement such as the replacement of a component that's no longer available or the replacement of a component with a substitute due to a shortage in current stock. - guidedTaskId:
- guidedTaskSteps
-
Operation: /fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks/{guidedTaskId}/child/guidedTaskStepsParameters:
- guidedTaskId:
$request.path.guidedTaskId
Steps that are used as building blocks to construct a guided task process. You can assemble a guided task step using steps such as Review and Submit or Replacement Component Search. - guidedTaskId: