Get all smart form details
get
/fscmRestApi/resources/11.13.18.05/shoppingCatalogSmartFormDetails
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- FindBySmartFormId: Find smart form details using the SmartFormId.
Finder Variables:- SmartFormId; integer; Value that uniquely identifies the smart form.
- SysEffectiveDate; object.
- PrimaryKey: Find smart form details according to the primary key.
Finder Variables:- SmartFormId; integer; Value that uniquely identifies the smart form.
- FindBySmartFormId: Find smart form details using the SmartFormId.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- SmartFormId; integer; Value that uniquely identifies the smart form.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : shoppingCatalogSmartFormDetails
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shoppingCatalogSmartFormDetails-item-response
Type:
Show Source
object
-
AgreementEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the agreement can be updated. If false, then the agreement can't be updated. -
agreementRequisitionBUAssignments: array
Agreement Requisition Business Unit Assignments
Title:
Agreement Requisition Business Unit Assignments
The Agreement Requisition Business Unit Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the requisition business unit assignments associated with an agreement specified in the smart form. -
AllowOrderFromUnassignedSitesFlag: boolean
Read Only:
true
Maximum Length:255
Contains one of the following values: true or false. If true, the agreement allows ordering from unassigned sites. If false, the order must be placed with supplier site on the agreement. -
Amount: number
Total amount of the requested items in the currency of the buying company.
-
AmountEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the amount can be updated. If false, then the amount can't be updated. -
attachments: array
Attachments for Smart Forms
Title:
Attachments for Smart Forms
The Attachments for Smart Forms resource retrieves attachments for the smart form. -
CategoryEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the category can be updated. If false, then the category can't be updated. -
CategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
CategoryName: string
Read Only:
true
Maximum Length:2400
Name of the purchasing category that is used for classifying the purchase being made by using this smart form. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the the smart form. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the smart form was created. -
Currency: string
Title:
Currency Name
Read Only:true
Maximum Length:80
Smart form item currency name. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the smart form item currency. -
CurrencyEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the currency can be updated. If false, then the currency can't be updated. -
DescriptionEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the description can be updated. If false, then the description can't be updated. -
informationTemplateAssignments: array
Information Template Assignments
Title:
Information Template Assignments
The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the information templates associated with a smart form. -
InstructionText: string
Maximum Length:
250
Instruction text for users to know how to use the form for ordering goods or services. -
ItemDescription: string
Maximum Length:
240
Description of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date when the record was last updated. -
LineType: string
Title:
Type
Read Only:true
Maximum Length:30
Value that uniquely identifies the line type. Values include Goods, Fixed Price Services, and so on. -
LineTypeId: integer
(int64)
Value that uniquely identifies type that indicates whether a purchase requisition line is for goods or services.
-
LineTypeOrderTypeLookupCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the type of agreement line. Valid values are QUANTITY or FIXED PRICE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Manufacturer: string
Maximum Length:
30
Manufacturer name. -
ManufacturerEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the manufacturer can be updated. If false, then the manufacturer can't be updated. -
ManufacturerPartNumber: string
Maximum Length:
700
Number that uniquely identifies the item as provided by the manufacturer. -
NegotiatedByPreparerFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the price on the purchase requisition line is agreed on in advance between the buying company and the supplier. If false, then the price is not agreed on in advance. -
NegotiatedEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the negotiated by preparer option can be updated. If false, then the negotiated by preparer option can't be updated. -
NegotiationRequiredEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the negotiation required option can be updated. If false, then the negotiation required option can't be updated. -
NegotiationRequiredFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then a request for quotation is required prior to placing the requisition line on a purchase order. If false, then a request for quotation is not required. -
PartNumberEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the manufacturer part number can be updated. If false, then the manufacturer part number can't be updated. -
ProcurementBU: string
Title:
Organization
Read Only:true
Maximum Length:240
Business unit responsible for managing the procurement function. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit responsible for managing the procurement function.
-
ProductType: string
Title:
Product Type
Read Only:true
Maximum Length:30
Value that uniquely identifies the product type. Values include Goods and Services. -
Quantity: number
Quantity of the goods being purchased.
-
RestrictToBrowsingCategoryId: integer
(int64)
Value that uniquely identifies the browsing category to which purchasing categories are restricted.
-
RestrictToBrowsingCategoryName: string
Read Only:
true
Maximum Length:240
Name of the browsing category that is used for restricting the values displayed in the purchasing category LOV. -
SmartFormId: integer
(int64)
Value that uniquely identifies the smart form.
-
SmartFormName: string
Maximum Length:
250
The name of the smart form. -
SourceAgreement: string
Read Only:
true
Maximum Length:255
Number that uniquely identifies the purchase agreement referenced by the smart form. -
SourceAgreementHeaderId: integer
Read Only:
true
Value that uniquely identifies the purchase agreement referenced by the smart form. -
Supplier: string
Title:
Organization Name
Read Only:true
Maximum Length:360
Name of the supplier tasked with fulfillment of the ordered goods and services. -
SupplierContact: string
Read Only:
true
Maximum Length:255
Name of the person representing the supplier with regards to communication with the buying company. -
SupplierContactEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier contact can be updated. If false, then the supplier contact can't be updated. -
SupplierContactEmail: string
Maximum Length:
240
Email of the supplier contact. -
SupplierContactEmailEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier contact email can be updated. If false, then the supplier contact email can't be updated. -
SupplierContactFax: string
Maximum Length:
30
Fax number of the supplier contact. -
SupplierContactFaxEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier contact fax number can be updated. If false, then the supplier contact fax number can't be updated. -
SupplierContactId: integer
(int64)
Value that uniquely identifies the supplier contact.
-
SupplierContactPhone: string
Maximum Length:
30
Phone number of the supplier contact. -
SupplierContactPhoneEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier contact phone number can be updated. If false, then the supplier contact phone number can't be updated. -
SupplierEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier can be updated. If false, then the supplier can't be updated. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierItemEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier item number can be updated. If false, then the supplier item number can't be updated. -
SupplierItemNumber: string
Maximum Length:
300
Number that identifies the supplier or code for the goods or services to be ordered. -
SupplierSite: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier location from where goods or services are purchased. -
SupplierSiteEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the supplier site can be updated. If false, then the supplier site can't be updated. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
UnitPrice: number
Price of the requested item in the currency of the buying company.
-
UnitPriceEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the unit price can be updated. If false, then the unit price can't be updated. -
UOM: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure of the item quantity. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
UOMEditableFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, the UOM can be updated. If false, then the UOM can't be updated.
Nested Schema : Agreement Requisition Business Unit Assignments
Type:
array
Title:
Agreement Requisition Business Unit Assignments
The Agreement Requisition Business Unit Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the requisition business unit assignments associated with an agreement specified in the smart form.
Show Source
Nested Schema : Attachments for Smart Forms
Type:
array
Title:
Attachments for Smart Forms
The Attachments for Smart Forms resource retrieves attachments for the smart form.
Show Source
Nested Schema : Information Template Assignments
Type:
array
Title:
Information Template Assignments
The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the information templates associated with a smart form.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shoppingCatalogSmartFormDetails-agreementRequisitionBUAssignments-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequisitionBUAssignmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the assignment. -
RequisitioningBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit responsible for managing the requisitioning function. -
RequisitioningBUName: string
Title:
Organization
Read Only:true
Maximum Length:240
Business unit responsible for managing the requisitioning function. -
SupplierContact: string
Read Only:
true
Maximum Length:4000
Name of the person representing the supplier with regards to communication with the buying company. -
SupplierContactEmail: string
Read Only:
true
Maximum Length:2000
Email of the supplier contact. -
SupplierContactFax: string
Read Only:
true
Maximum Length:255
Fax number of the supplier contact. -
SupplierContactId: integer
Read Only:
true
Value that uniquely identifies the supplier contact. -
SupplierContactPhone: string
Read Only:
true
Maximum Length:255
Phone number of the supplier contact. -
SupplierSite: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier location from where goods or services are purchased. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site.
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 : shoppingCatalogSmartFormDetails-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the attachment category. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the document from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the document version from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents of the attachment are no longer valid. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached file. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attached file. -
FileUrl: string
Title:
File Url
Uniform resource locator of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The Base64-encoded image of the file displayed in .PNG format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached file. -
UploadedFileLength: integer
Title:
File Size
Size of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Contents of the text file that is attached. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the topology manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
Uniform resource locator of the web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when creating the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shoppingCatalogSmartFormDetails-informationTemplateAssignments-item-response
Type:
Show Source
object
-
DFFContextCode: string
Title:
Attribute List
Read Only:true
Maximum Length:30
Context code of the information templates descriptive flexfields assigned to the information template. -
InformationTemplate: string
Title:
Information Template
Read Only:true
Maximum Length:250
Name of the information template. -
InformationTemplateAssignmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies information template assignment with the smart form. -
InformationTemplateDisplayName: string
Title:
Display Name
Read Only:true
Maximum Length:250
Display name of the information template. -
InformationTemplateId: integer
(int64)
Read Only:
true
Value that uniquely identifies the information template. -
InstructionText: string
Title:
Instruction Text
Read Only:true
Maximum Length:250
Instructional text for how to use the additional information required for ordering goods or services. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SmartFormId: integer
(int64)
Read Only:
true
Value that uniquely identifies the smart form.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source