Jump to

• Request
• Response

Create guided task steps

post

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

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=

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

  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 schema

{
    "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 : schema

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

Body ()

Root 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 : 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-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

objectSearchViews

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

Parameters:

• guidedTaskId: $request.path.guidedTaskId
• stepId: $request.path.stepId

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.

Back to Top