Jump to

• Request
• Response

Create guided tasks

post

/fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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(required): string
  Maximum Length: 150

  Value that identifies the header object for a guided task.
• image: string (byte)
  Image for a guided task.
• name: string
  Maximum Length: 150

  Name of a translated guided task.
• status(required): string
  Maximum Length: 100

  Status for a guided task.
• visibility: string
  Maximum Length: 150

  Value that identifies the visibility for a guided task.

{
    "required":[
        "headerObject",
        "status"
    ],
    "type":"object",
    "properties":{
        "globalContext":{
            "maxLength":3000,
            "type":"string",
            "description":"Value that identifies the global context for a guided task.",
            "nullable":true
        },
        "image":{
            "type":"string",
            "description":"Image for a guided task.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "visibility":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the visibility for a guided task.",
            "nullable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Name of a translated guided task.",
            "nullable":true
        },
        "description":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of a description for a translated guided task.",
            "nullable":true
        },
        "guidedTaskSteps":{
            "title":"Guided Task Steps",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-item-post-request"
            }
        },
        "guidedTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "headerObject":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the header object for a guided task.",
            "nullable":false
        },
        "status":{
            "maxLength":100,
            "type":"string",
            "description":"Status for a guided task.",
            "nullable":false
        },
        "guidedTaskInstances":{
            "title":"Guided Task Instances",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskInstances-item-post-request"
            }
        }
    }
}

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

• Array of: object productManagementGuidedTasks-guidedTaskInstances-item-post-request

{
    "title":"Guided Task Instances",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskInstances-item-post-request"
    }
}

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

• Array of: object productManagementGuidedTasks-guidedTaskSteps-item-post-request

{
    "title":"Guided Task Steps",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-item-post-request"
    }
}

Nested Schema : productManagementGuidedTasks-guidedTaskInstances-item-post-request

Type: object

Show Source

• 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.
• 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.
• status: string
  Maximum Length: 30

  Value that identifies the status of a guided task instance.
• taskConfigMetadata: string (byte)
  Value that identifies the metadata for a guided task instance.

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task instance job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "metadata":{
            "maxLength":3000,
            "type":"string",
            "description":"Value that identifies the metadata for a guided task instance.",
            "nullable":true
        },
        "instanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "taskConfigMetadata":{
            "type":"string",
            "description":"Value that identifies the metadata for a guided task instance.",
            "format":"byte",
            "nullable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the guided task instance.",
            "nullable":true
        },
        "description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the guided task instance.",
            "nullable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the status of a guided task instance.",
            "nullable":false
        }
    }
}

Nested Schema : productManagementGuidedTasks-guidedTaskSteps-item-post-request

Type: object

Show Source

• description: string
  Maximum Length: 1000

  Description of the translated guided task step.
• 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.
• 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(required): string
  Maximum Length: 150

  Value that identifies the step object for a guided task step.
• stepSearchViewIds: string
  Maximum Length: 500

  Value that uniquely identifies the step search view.
• stepType(required): string
  Maximum Length: 150

  Value that identifies the step type for a guided task step.

{
    "required":[
        "stepObject",
        "stepType"
    ],
    "type":"object",
    "properties":{
        "stepType":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the step type for a guided task step.",
            "nullable":false
        },
        "objectSearchViews":{
            "title":"Object Search Views",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-post-request"
            }
        },
        "stepSearchViewIds":{
            "maxLength":500,
            "type":"string",
            "description":"Value that uniquely identifies the step search view.",
            "nullable":true
        },
        "stepId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the guided task step.",
            "nullable":true
        },
        "description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the translated guided task step.",
            "nullable":true
        },
        "stepNumber":{
            "type":"integer",
            "description":"Value that identifies the number for a guided task step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "stepObject":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the step object for a guided task step.",
            "nullable":false
        }
    }
}

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

• Array of: object productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-post-request

{
    "title":"Object Search Views",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-post-request"
    }
}

Nested Schema : productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-post-request

Type: object

Show Source

• 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.
• name: string
  Maximum Length: 150

  Translated name of the object search view.
• object: string
  Maximum Length: 150

  Name of the object search view.
• 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.

{
    "type":"object",
    "properties":{
        "searchViewId":{
            "type":"integer",
            "description":"Value that uniquely identifies the object search view.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "hint":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the hint for an object search view.",
            "nullable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Translated name of the object search view.",
            "nullable":true
        },
        "label":{
            "maxLength":150,
            "type":"string",
            "description":"Label for an object search view.",
            "nullable":true
        },
        "object":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the object search view.",
            "nullable":false
        },
        "searchConfig":{
            "maxLength":3000,
            "type":"string",
            "description":"Value that identifies the search configuration for an object search view.",
            "nullable":true
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : productManagementGuidedTasks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "globalContext":{
            "maxLength":3000,
            "type":"string",
            "description":"Value that identifies the global context for a guided task.",
            "nullable":true,
            "x-queryable":true
        },
        "image":{
            "type":"string",
            "description":"Image for a guided task.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "updatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the guided task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "visibility":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the visibility for a guided task.",
            "nullable":true,
            "x-queryable":true
        },
        "statusValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the meaning of status for a guided task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "headerObjectValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the meaning of header object for a guided task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "description":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of a description for a translated guided task.",
            "nullable":true,
            "x-queryable":true
        },
        "guidedTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "guidedTaskInstances":{
            "title":"Guided Task Instances",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskInstances-item-response"
            }
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the guided task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "timeUpdated":{
            "type":"string",
            "description":"Date when the user most recently updated the guided task.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Name of a translated guided task.",
            "nullable":true,
            "x-queryable":true
        },
        "guidedTaskSteps":{
            "title":"Guided Task Steps",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Date and time when the user created the guided task.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "headerObject":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the header object for a guided task.",
            "nullable":false,
            "x-queryable":true
        },
        "status":{
            "maxLength":100,
            "type":"string",
            "description":"Status for a guided task.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object productManagementGuidedTasks-guidedTaskInstances-item-response

{
    "title":"Guided Task Instances",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskInstances-item-response"
    }
}

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

• Array of: object productManagementGuidedTasks-guidedTaskSteps-item-response

{
    "title":"Guided Task Steps",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productManagementGuidedTasks-guidedTaskInstances-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "metadata":{
            "maxLength":3000,
            "type":"string",
            "description":"Value that identifies the metadata for a guided task instance.",
            "nullable":true,
            "x-queryable":true
        },
        "updatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the guided task instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "taskConfigMetadata":{
            "type":"string",
            "description":"Value that identifies the metadata for a guided task instance.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "statusValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the status for a guided task instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the guided task instance.",
            "nullable":true,
            "x-queryable":true
        },
        "jobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task instance job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "instanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the guided task instance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "timeUpdated":{
            "type":"string",
            "description":"Date when the user most recently updated the guided task instance.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the guided task instance.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Date and time when the user created the guided task instance.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the status of a guided task instance.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : productManagementGuidedTasks-guidedTaskSteps-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "updatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the guided task step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stepType":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the step type for a guided task step.",
            "nullable":false,
            "x-queryable":true
        },
        "objectSearchViews":{
            "title":"Object Search Views",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-response"
            }
        },
        "stepId":{
            "type":"integer",
            "description":"Value that uniquely identifies the guided task step.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the translated guided task step.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the guided task step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "stepSearchViewIds":{
            "maxLength":500,
            "type":"string",
            "description":"Value that uniquely identifies the step search view.",
            "nullable":true,
            "x-queryable":true
        },
        "timeUpdated":{
            "type":"string",
            "description":"Date when the user most recently updated the guided task step.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the guided task step.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Date and time when the user created the guided task step.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stepNumber":{
            "type":"integer",
            "description":"Value that identifies the number for a guided task step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "stepTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the meaning of step type for a guided task step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "stepObjectValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the meaning of step object for a guided task step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "stepObject":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the step object for a guided task step.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-response

{
    "title":"Object Search Views",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-response"
    }
}

Nested Schema : productManagementGuidedTasks-guidedTaskSteps-objectSearchViews-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "searchViewId":{
            "type":"integer",
            "description":"Value that uniquely identifies the object search view.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "updatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the guided task object search view.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "objectValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the meaning of object for an object search view.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "label":{
            "maxLength":150,
            "type":"string",
            "description":"Label for an object search view.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the guided task object search view.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "timeUpdated":{
            "type":"string",
            "description":"Date when the user most recently updated the guided task object search view.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "hint":{
            "maxLength":150,
            "type":"string",
            "description":"Value that identifies the hint for an object search view.",
            "nullable":true,
            "x-queryable":true
        },
        "name":{
            "maxLength":150,
            "type":"string",
            "description":"Translated name of the object search view.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "timeCreated":{
            "type":"string",
            "description":"Date and time when the user created the guided task object search view.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "object":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the object search view.",
            "nullable":false,
            "x-queryable":true
        },
        "searchConfig":{
            "maxLength":3000,
            "type":"string",
            "description":"Value that identifies the search configuration for an object search view.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

guidedTaskInstances

Operation: /fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks/{guidedTaskId}/child/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.

guidedTaskSteps

Operation: /fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks/{guidedTaskId}/child/guidedTaskSteps

Parameters:

• 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.

Back to Top