Jump to

• Request
• Response

Create one smart form

post

/fscmRestApi/resources/11.13.18.05/smartForms

Request

Header Parameters

• Effective-Of: string
  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: string
  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: string
  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: string
  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

• 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
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• categoryAssignmentsForCatalogBrowsing: array Category Assignments for Catalog Browsing
  Title: Category Assignments for Catalog Browsing

  Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.
• 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)
  Unique identifier for the purchasing category of the smart form item.
• contentZonesAssigned: array Assigned Content Zones
  Title: Assigned Content Zones

  Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.
• 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.
• ImageURL: string
  Maximum Length: 250

  URL that locates the image representing the smart form.
• 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's used to view the information templates associated with a smart form.
• InstructionText: string
  Maximum Length: 250

  Instructional text for how to use the additional information required for ordering goods or services.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemDescriptionEditableFlag: 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.
• Keywords(required): string
  Maximum Length: 4000

  Keywords used to search for the smart form.
• LineTypeId(required): integer (int64)
  Value that uniquely identifies type that indicates whether a purchase requisition line is for goods or services.
• 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.
• ManufacturerPartNumberEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the manufacturer part number can be updated. If false, the manufacturer part number can't be updated.
• NegotiatedByPreparerEditableFlag: 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.
• 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 isn't agreed on in advance.
• 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 isn't required.
• Price: number
  Price of the requested item in the currency of the supplier.
• PriceEditableFlag: 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.
• ProcurementBUId(required): integer (int64)
  Value that uniquely identifies the business unit responsible for managing the procurement function.
• Quantity: number
  Quantity of the goods being purchased.
• RestrictToBrowsingCategoryId: integer (int64)
  Value that uniquely identifies the browsing category to which purchasing categories are restricted.
• SmartFormName(required): string
  Maximum Length: 250

  Name of the smart form.
• SourceAgreementEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the source agreement can be updated. If false, then the source agreement can't be updated.
• SourceAgreementHeaderId: integer (int64)
  Value that uniquely identifies the purchase agreement referenced by the smart form.
• 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 details 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.
• SupplierItemNumber: string
  Maximum Length: 300

  Number that identifies the supplier or code for the goods or services to be ordered.
• SupplierItemNumberEditableFlag: 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.
• 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.
• 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.

{
    "required":[
        "Keywords",
        "LineTypeId",
        "ProcurementBUId",
        "SmartFormName"
    ],
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"Total amount of the requested items in the currency of the buying company.",
            "nullable":true,
            "x-queryable":false
        },
        "AmountEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier for the purchasing category of the smart form item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the smart form item currency.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":250,
            "type":"string",
            "description":"URL that locates the image representing the smart form.",
            "nullable":true,
            "x-queryable":false
        },
        "InstructionText":{
            "maxLength":250,
            "type":"string",
            "description":"Instructional text for how to use the additional information required for ordering goods or services.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescriptionEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "Keywords":{
            "maxLength":4000,
            "type":"string",
            "description":"Keywords used to search for the smart form.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "KeywordsClob"
                ]
            }
        },
        "LineTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies type that indicates whether a purchase requisition line is for goods or services.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Manufacturer":{
            "maxLength":30,
            "type":"string",
            "description":"Manufacturer name.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number that uniquely identifies the item as provided by the manufacturer.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerPartNumberEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the manufacturer part number can be updated. If false, the manufacturer part number can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiatedByPreparerEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiatedByPreparerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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 isn't agreed on in advance.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiationRequiredEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiationRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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 isn't required.",
            "nullable":true,
            "x-queryable":false
        },
        "Price":{
            "type":"number",
            "description":"Price of the requested item in the currency of the supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit responsible for managing the procurement function.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the goods being purchased.",
            "nullable":true,
            "x-queryable":false
        },
        "RestrictToBrowsingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the browsing category to which purchasing categories are restricted.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SmartFormName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the smart form.",
            "nullable":false
        },
        "SourceAgreementEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the source agreement can be updated. If false, then the source agreement can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceAgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement referenced by the smart form.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierContactEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactEmail":{
            "maxLength":240,
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactEmailEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactFax":{
            "maxLength":30,
            "type":"string",
            "description":"Fax details of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactFaxEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierContactPhone":{
            "maxLength":30,
            "type":"string",
            "description":"Phone number of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactPhoneEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the supplier or code for the goods or services to be ordered.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierItemNumberEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSiteEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/smartForms-attachments-item-post-request"
            }
        },
        "categoryAssignmentsForCatalogBrowsing":{
            "title":"Category Assignments for Catalog Browsing",
            "type":"array",
            "description":"Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.",
            "items":{
                "$ref":"#/components/schemas/smartForms-categoryAssignmentsForCatalogBrowsing-item-post-request"
            }
        },
        "contentZonesAssigned":{
            "title":"Assigned Content Zones",
            "type":"array",
            "description":"Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.",
            "items":{
                "$ref":"#/components/schemas/smartForms-contentZonesAssigned-item-post-request"
            }
        },
        "informationTemplateAssignments":{
            "title":"Information Template Assignments",
            "type":"array",
            "description":"The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It's used to view the information templates associated with a smart form.",
            "items":{
                "$ref":"#/components/schemas/smartForms-informationTemplateAssignments-item-post-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object smartForms-attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/smartForms-attachments-item-post-request"
    }
}

Nested Schema : Category Assignments for Catalog Browsing

Type: array

Title: Category Assignments for Catalog Browsing

Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.

Show Source

• Array of: object schema

{
    "title":"Category Assignments for Catalog Browsing",
    "type":"array",
    "description":"Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.",
    "items":{
        "$ref":"#/components/schemas/smartForms-categoryAssignmentsForCatalogBrowsing-item-post-request"
    }
}

Nested Schema : Assigned Content Zones

Type: array

Title: Assigned Content Zones

Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.

Show Source

• Array of: object smartForms-contentZonesAssigned-item-post-request

{
    "title":"Assigned Content Zones",
    "type":"array",
    "description":"Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.",
    "items":{
        "$ref":"#/components/schemas/smartForms-contentZonesAssigned-item-post-request"
    }
}

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's used to view the information templates associated with a smart form.

Show Source

• Array of: object smartForms-informationTemplateAssignments-item-post-request

{
    "title":"Information Template Assignments",
    "type":"array",
    "description":"The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It's used to view the information templates associated with a smart form.",
    "items":{
        "$ref":"#/components/schemas/smartForms-informationTemplateAssignments-item-post-request"
    }
}

Nested Schema : smartForms-attachments-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryId: integer (int64)
  Unique identifier of a category assigned for catalog browsing.
• CategoryTypeCode: string
  Maximum Length: 10

  Code that identifies the type of category assigned to the smart form for catalog browsing. Valid values are BROWSING for a browsing category and ITEM for an item category.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of a category assigned for catalog browsing.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "CategoryTypeCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code that identifies the type of category assigned to the smart form for catalog browsing. Valid values are BROWSING for a browsing category and ITEM for an item category.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : smartForms-contentZonesAssigned-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : smartForms-informationTemplateAssignments-item-post-request

Type: object

Show Source

• InformationTemplateId: integer (int64)
  Value that uniquely identifies the information template.

{
    "type":"object",
    "properties":{
        "InformationTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the information template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        }
    }
}

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 : smartForms-item-response

Type: object

Show Source

• AgreementExpiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the agreement has expired. Contains one of these values: true or false. If true, then the agreement has expired. If false, then the agreement hasn't expired. This attribute doesn't have a default value.
• 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
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• categoryAssignmentsForCatalogBrowsing: array Category Assignments for Catalog Browsing
  Title: Category Assignments for Catalog Browsing

  Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.
• 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)
  Unique identifier for the purchasing category of the smart form item.
• CategoryName: string
  Read Only: true

  Maximum Length: 2400

  Name of the purchasing category that's used for classifying the purchase being made by using this smart form.
• ContentZoneAssignment: string
  Title: Content Zone Assignment

  Read Only: true

  Maximum Length: 255

  Associates a smart form with a content zone.
• contentZonesAssigned: array Assigned Content Zones
  Title: Assigned Content Zones

  Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.
• 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.
• ImageURL: string
  Maximum Length: 250

  URL that locates the image representing the smart form.
• 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's used to view the information templates associated with a smart form.
• InstructionText: string
  Maximum Length: 250

  Instructional text for how to use the additional information required for ordering goods or services.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemDescriptionEditableFlag: 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.
• Keywords: string
  Maximum Length: 4000

  Keywords used to search for the smart form.
• 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.
• 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.
• ManufacturerPartNumberEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the manufacturer part number can be updated. If false, the manufacturer part number can't be updated.
• NegotiatedByPreparerEditableFlag: 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.
• 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 isn't agreed on in advance.
• 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 isn't required.
• Price: number
  Price of the requested item in the currency of the supplier.
• PriceEditableFlag: 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.
• 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.
• 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: 30

  Name of the browsing category that's used for restricting the values displayed in the purchasing category list of values.
• SmartFormId: integer (int64)
  Read Only: true

  Value that uniquely identifies the smart form.
• SmartFormName: string
  Maximum Length: 250

  Name of the smart form.
• SourceAgreement: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase agreement referenced by the smart form.
• SourceAgreementEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the source agreement can be updated. If false, then the source agreement can't be updated.
• SourceAgreementHeaderId: integer (int64)
  Value that uniquely identifies the purchase agreement referenced by the smart form.
• Supplier: string
  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: 4000

  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 details 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.
• SupplierItemNumber: string
  Maximum Length: 300

  Number that identifies the supplier or code for the goods or services to be ordered.
• SupplierItemNumberEditableFlag: 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "AgreementExpiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the agreement has expired. Contains one of these values: true or false. If true, then the agreement has expired. If false, then the agreement hasn't expired. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Total amount of the requested items in the currency of the buying company.",
            "nullable":true,
            "x-queryable":false
        },
        "AmountEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier for the purchasing category of the smart form item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the purchasing category that's used for classifying the purchase being made by using this smart form.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContentZoneAssignment":{
            "title":"Content Zone Assignment",
            "maxLength":255,
            "type":"string",
            "description":"Associates a smart form with a content zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Smart form item currency name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the smart form item currency.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ImageURL":{
            "maxLength":250,
            "type":"string",
            "description":"URL that locates the image representing the smart form.",
            "nullable":true,
            "x-queryable":false
        },
        "InstructionText":{
            "maxLength":250,
            "type":"string",
            "description":"Instructional text for how to use the additional information required for ordering goods or services.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescriptionEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "Keywords":{
            "maxLength":4000,
            "type":"string",
            "description":"Keywords used to search for the smart form.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "KeywordsClob"
                ]
            }
        },
        "LineType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the line type. Values include Goods, Fixed Price Services, and so on.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies type that indicates whether a purchase requisition line is for goods or services.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Manufacturer":{
            "maxLength":30,
            "type":"string",
            "description":"Manufacturer name.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Number that uniquely identifies the item as provided by the manufacturer.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerPartNumberEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the manufacturer part number can be updated. If false, the manufacturer part number can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiatedByPreparerEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiatedByPreparerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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 isn't agreed on in advance.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiationRequiredEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiationRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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 isn't required.",
            "nullable":true,
            "x-queryable":false
        },
        "Price":{
            "type":"number",
            "description":"Price of the requested item in the currency of the supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcurementBU":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Business unit responsible for managing the procurement function.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit responsible for managing the procurement function.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the goods being purchased.",
            "nullable":true,
            "x-queryable":false
        },
        "RestrictToBrowsingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the browsing category to which purchasing categories are restricted.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RestrictToBrowsingCategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the browsing category that's used for restricting the values displayed in the purchasing category list of values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SmartFormId":{
            "type":"integer",
            "description":"Value that uniquely identifies the smart form.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SmartFormName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the smart form.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceAgreement":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement referenced by the smart form.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceAgreementEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the source agreement can be updated. If false, then the source agreement can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceAgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement referenced by the smart form.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier tasked with fulfillment of the ordered goods and services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierContact":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the person representing the supplier with regards to communication with the buying company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierContactEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactEmail":{
            "maxLength":240,
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactEmailEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactFax":{
            "maxLength":30,
            "type":"string",
            "description":"Fax details of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactFaxEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierContactPhone":{
            "maxLength":30,
            "type":"string",
            "description":"Phone number of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierContactPhoneEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the supplier or code for the goods or services to be ordered.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierItemNumberEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier location from where goods or services are purchased.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierSiteEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure of the item quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/smartForms-attachments-item-response"
            }
        },
        "categoryAssignmentsForCatalogBrowsing":{
            "title":"Category Assignments for Catalog Browsing",
            "type":"array",
            "description":"Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.",
            "items":{
                "$ref":"#/components/schemas/smartForms-categoryAssignmentsForCatalogBrowsing-item-response"
            }
        },
        "contentZonesAssigned":{
            "title":"Assigned Content Zones",
            "type":"array",
            "description":"Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.",
            "items":{
                "$ref":"#/components/schemas/smartForms-contentZonesAssigned-item-response"
            }
        },
        "informationTemplateAssignments":{
            "title":"Information Template Assignments",
            "type":"array",
            "description":"The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It's used to view the information templates associated with a smart form.",
            "items":{
                "$ref":"#/components/schemas/smartForms-informationTemplateAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object smartForms-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/smartForms-attachments-item-response"
    }
}

Nested Schema : Category Assignments for Catalog Browsing

Type: array

Title: Category Assignments for Catalog Browsing

Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.

Show Source

• Array of: object smartForms-categoryAssignmentsForCatalogBrowsing-item-response

{
    "title":"Category Assignments for Catalog Browsing",
    "type":"array",
    "description":"Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.",
    "items":{
        "$ref":"#/components/schemas/smartForms-categoryAssignmentsForCatalogBrowsing-item-response"
    }
}

Nested Schema : Assigned Content Zones

Type: array

Title: Assigned Content Zones

Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.

Show Source

• Array of: object smartForms-contentZonesAssigned-item-response

{
    "title":"Assigned Content Zones",
    "type":"array",
    "description":"Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.",
    "items":{
        "$ref":"#/components/schemas/smartForms-contentZonesAssigned-item-response"
    }
}

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's used to view the information templates associated with a smart form.

Show Source

• Array of: object smartForms-informationTemplateAssignments-item-response

{
    "title":"Information Template Assignments",
    "type":"array",
    "description":"The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It's used to view the information templates associated with a smart form.",
    "items":{
        "$ref":"#/components/schemas/smartForms-informationTemplateAssignments-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 : smartForms-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• 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

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : smartForms-categoryAssignmentsForCatalogBrowsing-item-response

Type: object

Show Source

• CategoryAssignmentId: integer (int64)
  Read Only: true

  Unique identifier of the category assignment.
• CategoryDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the category assigned for catalog browsing.
• CategoryId: integer (int64)
  Unique identifier of a category assigned for catalog browsing.
• CategoryName: string
  Read Only: true

  Maximum Length: 255

  Name of a category assigned for catalog browsing.
• CategoryType: string
  Read Only: true

  Maximum Length: 80

  Type of the category used for catalog browsing.
• CategoryTypeCode: string
  Maximum Length: 10

  Code that identifies the type of category assigned to the smart form for catalog browsing. Valid values are BROWSING for a browsing category and ITEM for an item category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CategoryAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the category assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the category assigned for catalog browsing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of a category assigned for catalog browsing.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of a category assigned for catalog browsing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of the category used for catalog browsing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryTypeCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code that identifies the type of category assigned to the smart form for catalog browsing. Valid values are BROWSING for a browsing category and ITEM for an item category.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : smartForms-contentZonesAssigned-item-response

Type: object

Show Source

• ContentZoneAssignmentId: integer (int64)
  Read Only: true

  Unique identifier of a smart form assignment to a content zone.
• ContentZoneId: integer (int64)
  Read Only: true

  The unique identifier of the content zone.
• ContentZoneName: string
  Read Only: true

  Maximum Length: 255

  Name of the content zone to which the smart form is assigned.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who assigned the smart form to the content zone.
• CreationDate: string (date-time)
  Read Only: true

  The date when the smart form was assigned to the content zone.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the smart form assignment to the content zone was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the smart form assignment to the content zone.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBUId: integer (int64)
  Read Only: true

  The unique identifier of the procurement BU where the content zone was created.
• SecurityDimension: string
  Read Only: true

  Maximum Length: 30

  Security dimension assigned to the content zone.
• SmartFormId: integer (int64)
  Read Only: true

  Unique identifier of the smart form.
• Usage: string
  Read Only: true

  Maximum Length: 30

  Indicates how the content zone is used.

{
    "type":"object",
    "properties":{
        "ContentZoneAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of a smart form assignment to a content zone.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContentZoneId":{
            "type":"integer",
            "description":"The unique identifier of the content zone.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContentZoneName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the content zone to which the smart form is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who assigned the smart form to the content zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the smart form was assigned to the content zone.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the smart form assignment to the content zone was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the smart form assignment to the content zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"The unique identifier of the procurement BU where the content zone was created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SecurityDimension":{
            "maxLength":30,
            "type":"string",
            "description":"Security dimension assigned to the content zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SmartFormId":{
            "type":"integer",
            "description":"Unique identifier of the smart form.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Usage":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates how the content zone is used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : smartForms-informationTemplateAssignments-item-response

Type: object

Show Source

• DFFContextCode: string
  Title: Attribute List

  Read Only: true

  Maximum Length: 30

  Context code of the information templates descriptive flexfields assigned to the information template.
• InactiveDate: string (date)
  Title: End Date

  Read Only: true

  The date when the information template becomes ineffective.
• 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)
  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.

{
    "type":"object",
    "properties":{
        "DFFContextCode":{
            "title":"Attribute List",
            "maxLength":30,
            "type":"string",
            "description":"Context code of the information templates descriptive flexfields assigned to the information template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InactiveDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the information template becomes ineffective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InformationTemplate":{
            "title":"Information Template",
            "maxLength":250,
            "type":"string",
            "description":"Name of the information template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InformationTemplateAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies information template assignment with the smart form.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InformationTemplateDisplayName":{
            "title":"Display Name",
            "maxLength":250,
            "type":"string",
            "description":"Display name of the information template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InformationTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the information template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "InstructionText":{
            "title":"Instruction Text",
            "maxLength":250,
            "type":"string",
            "description":"Instructional text for how to use the additional information required for ordering goods or services.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SmartFormId":{
            "type":"integer",
            "description":"Value that uniquely identifies the smart form.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

attachments

Operation: /fscmRestApi/resources/11.13.18.05/smartForms/{smartFormsUniqID}/child/attachments

Parameters:

• smartFormsUniqID: $request.path.smartFormsUniqID

The attachments resource is used to view, create, and update attachments.

categoryAssignmentsForCatalogBrowsing

Operation: /fscmRestApi/resources/11.13.18.05/smartForms/{smartFormsUniqID}/child/categoryAssignmentsForCatalogBrowsing

Parameters:

• smartFormsUniqID: $request.path.smartFormsUniqID

Category assignments for catalog browsing that are assigned to a smart form. For example, a smart form can be assigned to catalog categories used for browsing.

contentZonesAssigned

Operation: /fscmRestApi/resources/11.13.18.05/smartForms/{smartFormsUniqID}/child/contentZonesAssigned

Parameters:

• smartFormsUniqID: $request.path.smartFormsUniqID

Content zones assigned to a smart form. For example, a smart form can be assigned to multiple content zones.

informationTemplateAssignments

Operation: /fscmRestApi/resources/11.13.18.05/smartForms/{smartFormsUniqID}/child/informationTemplateAssignments

Parameters:

• smartFormsUniqID: $request.path.smartFormsUniqID

The Information Template Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It's used to view the information templates associated with a smart form.

Back to Top