Update one guided task

patch

/fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks/{guidedTaskId}

Request

Path Parameters
  • 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=
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
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 : schema
Type: object
Show Source
  • Maximum Length: 150
    Value that identifies the hint for an object search view.
  • Maximum Length: 150
    Label for an object search view.
  • Maximum Length: 150
    Translated name of the object search view.
  • Maximum Length: 150
    Name of the object search view.
  • Maximum Length: 3000
    Value that identifies the search configuration for an object search view.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : productManagementGuidedTasks-item-response
Type: object
Show Source
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 : productManagementGuidedTasks-guidedTaskInstances-item-response
Type: object
Show Source
Nested Schema : productManagementGuidedTasks-guidedTaskSteps-item-response
Type: object
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: object
Show Source
Back to Top