Newer Version Available

This content describes an older version of this product. View Latest

SvcCatalogFulfillFlowItem

Represents a variable in a fulfillment flow for Service Catalog that can accept input. This object is available in API version 53.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

Available to customers with Employee Productivity Plus or IT Service Center add-ons.

Fields

Field Details
CatalogFulfillmentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Id of the SvcCatalogFulfillmentFlow that this item belongs to.
This is a relationship field.
Relationship Name
CatalogFulfillment
Relationship Type
Lookup
Refers To
SvcCatalogFulfillmentFlow
CatalogInputVariable
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The FlowVariable the fulfillment flow property represents.
DisplayType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The display options available.
Possible values are:
  • Checkbox
  • Lookup
  • Number
  • Picklist
  • Text
The default value is 'Lookup'.
FieldDefinition
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The name of a field in the object provided in ObjectLookupDomainId that specifies the value for this variable. If DisplayType is Picklist, this value must be the name of a picklist field. If DisplayType is Lookup and FieldLookupDomainId is FieldDefinition, this value must be the name of a relationship field. This value can be a field from a standard or custom object.
FieldLookupDomainId
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of a standard or custom object that specifies the domain of that lookup or picklist. This value is relevant only if displayType is Lookup or Picklist.
This is a relationship field.
Relationship Name
FieldLookupDomain
Relationship Type
Lookup
Refers To
EntityDefinition
IsAdditionalQuestionsInputVariable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Determines if this variable accepts input for all additional questions that were asked to a user. This value can only be true if the DisplayType for this item is Text. Only one item per SvcCatalogFulfillmentFlow component can set this attribute to true.
The default value is 'false'.
IsRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Determines if the field is required for the related fulfillment flow to be executed.
The default value is 'false'.
LookupDomainFieldType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This value specifies the fields for the object specified by ObjectLookupDomainId that are displayed in the Catalog Builder by type. This value is only relevant if DisplayType is Lookup and fieldLookupDomain is FieldDefinition.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The primary label for the fulfillment flow record.
ObjectLookupDomainId
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of a custom or standard object. If DisplayType is Lookup or Picklist, this value filters the available options to a specific object.
This is a relationship field.
Relationship Name
ObjectLookupDomain
Relationship Type
Lookup
Refers To
EntityDefinition