Jump to

• Request
• Response

Get all smart form details

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogSmartFormDetails

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • FindBySmartFormId: Finds smart form details using the Smart Form ID.
    Finder Variables:
    • SmartFormId; integer; Value that uniquely identifies the smart form.
    • SysEffectiveDate; object.
  • PrimaryKey: Finds smart form details according to the primary key.
    Finder Variables:
    • SmartFormId; integer; Value that uniquely identifies the smart form.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • SmartFormId; integer; Value that uniquely identifies the smart form.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : shoppingCatalogSmartFormDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogSmartFormDetails-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object shoppingCatalogSmartFormDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogSmartFormDetails-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 : shoppingCatalogSmartFormDetails-item-response

Type: object

Show Source

• AgreementEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the agreement can be updated. If false, then the agreement can't be updated.
• agreementRequisitionBUAssignments: array Agreement Requisition Business Unit Assignments
  Title: Agreement Requisition Business Unit Assignments

  The Agreement Requisition Business Unit Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the requisition business unit assignments associated with an agreement specified in the smart form.
• AllowOrderFromUnassignedSitesFlag: boolean
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, the agreement allows ordering from unassigned sites. If false, the order must be placed with supplier site on the agreement.
• Amount: number
  Total amount of the requested items in the currency of the buying company.
• AmountEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the amount can be updated. If false, then the amount can't be updated.
• attachments: array Attachments for Smart Forms
  Title: Attachments for Smart Forms

  The Attachments for Smart Forms resource retrieves attachments for the smart form.
• CategoryEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the category can be updated. If false, then the category can't be updated.
• CategoryId: integer (int64)
  Value that uniquely identifies the purchasing category.
• CategoryName: string
  Read Only: true

  Maximum Length: 2400

  Name of the purchasing category that's used for classifying the purchase being made by using this smart form.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the smart form.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the smart form was created.
• Currency: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Smart form item currency name.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the smart form item currency.
• CurrencyEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the currency can be updated. If false, then the currency can't be updated.
• DescriptionEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the description can be updated. If false, then the description can't be updated.
• informationTemplateAssignments: array Information Template Assignments
  Title: Information Template Assignments

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

  Instruction text for users to know how to use the form for ordering goods or services.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the record was last updated.
• LineType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the line type. Values include Goods, Fixed Price Services, and so on.
• LineTypeId: integer (int64)
  Value that uniquely identifies type that indicates whether a purchase requisition line is for goods or services.
• LineTypeOrderTypeLookupCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the type of agreement line. Valid values are QUANTITY or FIXED PRICE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Manufacturer: string
  Maximum Length: 30

  Manufacturer name.
• ManufacturerEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the manufacturer can be updated. If false, then the manufacturer can't be updated.
• ManufacturerPartNumber: string
  Maximum Length: 700

  Number that uniquely identifies the item as provided by the manufacturer.
• NegotiatedByPreparerFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the price on the purchase requisition line is agreed on in advance between the buying company and the supplier. If false, then the price is not agreed on in advance.
• NegotiatedEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the negotiated by preparer option can be updated. If false, then the negotiated by preparer option can't be updated.
• NegotiationRequiredEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the negotiation required option can be updated. If false, then the negotiation required option can't be updated.
• NegotiationRequiredFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then a request for quotation is required prior to placing the requisition line on a purchase order. If false, then a request for quotation is not required.
• PartNumberEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the manufacturer part number can be updated. If false, then the manufacturer part number can't be updated.
• ProcurementBU: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  Business unit responsible for managing the procurement function.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the business unit responsible for managing the procurement function.
• ProductType: string
  Title: Product Type

  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the product type. Values are Goods and Services.
• PurchaseBasis: string
  Title: Purchase Basis

  Read Only: true

  Maximum Length: 30

  Value that identifies the basis for the purchase. The values are Goods, when the basis for the purchase is quantity, and Services, when the basis for the purchase is amount.
• Quantity: number
  Quantity of the goods being purchased.
• RestrictToBrowsingCategoryId: integer (int64)
  Value that uniquely identifies the browsing category to which purchasing categories are restricted.
• RestrictToBrowsingCategoryName: string
  Read Only: true

  Maximum Length: 240

  Name of the browsing category that's used for restricting the values displayed in the purchasing category list of values.
• SmartFormId: integer (int64)
  Value that uniquely identifies the smart form.
• SmartFormName: string
  Maximum Length: 250

  Name of the smart form.
• SourceAgreement: string
  Read Only: true

  Maximum Length: 255

  Number that uniquely identifies the purchase agreement referenced by the smart form.
• SourceAgreementHeaderId: integer
  Read Only: true

  Value that uniquely identifies the purchase agreement referenced by the smart form.
• Supplier: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 360

  Name of the supplier tasked with fulfillment of the ordered goods and services.
• SupplierContact: string
  Read Only: true

  Maximum Length: 255

  Name of the person representing the supplier with regards to communication with the buying company.
• SupplierContactEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the supplier contact can be updated. If false, then the supplier contact can't be updated.
• SupplierContactEmail: string
  Maximum Length: 240

  Email of the supplier contact.
• SupplierContactEmailEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the supplier contact email can be updated. If false, then the supplier contact email can't be updated.
• SupplierContactFax: string
  Maximum Length: 30

  Fax 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.
• SupplierItemEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the supplier item number can be updated. If false, then the supplier item number can't be updated.
• SupplierItemNumber: string
  Maximum Length: 300

  Number that identifies the supplier or code for the goods or services to be ordered.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier location from where goods or services are purchased.
• SupplierSiteEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the supplier site can be updated. If false, then the supplier site can't be updated.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• UnitPrice: number
  Price of the requested item in the currency of the buying company.
• UnitPriceEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the unit price can be updated. If false, then the unit price can't be updated.
• UOM: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure of the item quantity.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• UOMEditableFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the UOM can be updated. If false, then the UOM can't be updated.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the smart form was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "SupplierContactEmail":{
            "maxLength":"240",
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "PurchaseBasis":{
            "title":"Purchase Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the basis for the purchase. The values are Goods, when the basis for the purchase is quantity, and Services, when the basis for the purchase is amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UnitPriceEditableFlag":{
            "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
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the smart form item currency.",
            "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
        },
        "InstructionText":{
            "maxLength":"250",
            "type":"string",
            "description":"Instruction text for users to know how to use the form for ordering goods or services.",
            "nullable":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":"80",
            "type":"string",
            "description":"Smart form item currency name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Manufacturer":{
            "maxLength":"30",
            "type":"string",
            "description":"Manufacturer name.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartNumberEditableFlag":{
            "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, then the manufacturer part number can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "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":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date when the record was last updated.",
            "nullable":false,
            "readOnly":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-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SupplierItemEditableFlag":{
            "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the smart form.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "agreementRequisitionBUAssignments":{
            "title":"Agreement Requisition Business Unit Assignments",
            "type":"array",
            "description":"The Agreement Requisition Business Unit Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the requisition business unit assignments associated with an agreement specified in the smart form.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogSmartFormDetails-agreementRequisitionBUAssignments-item-response"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the product type. Values are Goods and Services.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SmartFormName":{
            "maxLength":"250",
            "type":"string",
            "description":"Name of the smart form.",
            "nullable":false,
            "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
        },
        "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/shoppingCatalogSmartFormDetails-informationTemplateAssignments-item-response"
            }
        },
        "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 is not required.",
            "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"
            }
        },
        "SourceAgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement referenced by the smart form.",
            "nullable":true,
            "readOnly":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
        },
        "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
        },
        "SmartFormId":{
            "type":"integer",
            "description":"Value that uniquely identifies the smart form.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "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
        },
        "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
        },
        "AllowOrderFromUnassignedSitesFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the agreement allows ordering from unassigned sites. If false, the order must be placed with supplier site on the agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments for Smart Forms",
            "type":"array",
            "description":"The Attachments for Smart Forms resource retrieves attachments for the smart form.",
            "items":{
                "$ref":"#/components/schemas/shoppingCatalogSmartFormDetails-attachments-item-response"
            }
        },
        "SupplierContact":{
            "maxLength":"255",
            "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
        },
        "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
        },
        "SupplierContactFax":{
            "maxLength":"30",
            "type":"string",
            "description":"Fax details of the supplier contact.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":false
        },
        "NegotiatedEditableFlag":{
            "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
        },
        "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
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Supplier":{
            "title":"Organization Name",
            "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
        },
        "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
        },
        "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
        },
        "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":false
        },
        "SourceAgreement":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement referenced by the smart form.",
            "nullable":true,
            "readOnly":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
        },
        "Amount":{
            "type":"number",
            "description":"Total amount of the requested items in the currency of the buying company.",
            "nullable":true,
            "x-queryable":false
        },
        "LineTypeOrderTypeLookupCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the type of agreement line. Valid values are QUANTITY or FIXED PRICE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the goods being purchased.",
            "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 is not agreed on in advance.",
            "nullable":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "UnitPrice":{
            "type":"number",
            "description":"Price of the requested item in the currency of the buying company.",
            "nullable":true,
            "x-queryable":false
        },
        "DescriptionEditableFlag":{
            "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
        },
        "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
        },
        "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
        },
        "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":"240",
            "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
        },
        "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
        },
        "AgreementEditableFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the agreement can be updated. If false, then the agreement can't be updated.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Agreement Requisition Business Unit Assignments

Type: array

Title: Agreement Requisition Business Unit Assignments

The Agreement Requisition Business Unit Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the requisition business unit assignments associated with an agreement specified in the smart form.

Show Source

• Array of: object shoppingCatalogSmartFormDetails-agreementRequisitionBUAssignments-item-response

{
    "title":"Agreement Requisition Business Unit Assignments",
    "type":"array",
    "description":"The Agreement Requisition Business Unit Assignments resource is a child of the Shopping Catalog Smart Form Details resource. It is used to view the requisition business unit assignments associated with an agreement specified in the smart form.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogSmartFormDetails-agreementRequisitionBUAssignments-item-response"
    }
}

Nested Schema : Attachments for Smart Forms

Type: array

Title: Attachments for Smart Forms

The Attachments for Smart Forms resource retrieves attachments for the smart form.

Show Source

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

{
    "title":"Attachments for Smart Forms",
    "type":"array",
    "description":"The Attachments for Smart Forms resource retrieves attachments for the smart form.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogSmartFormDetails-attachments-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 shoppingCatalogSmartFormDetails-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/shoppingCatalogSmartFormDetails-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 : shoppingCatalogSmartFormDetails-agreementRequisitionBUAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Value that uniquely identifies the assignment.
• RequisitioningBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit responsible for managing the requisitioning function.
• RequisitioningBUName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  Business unit responsible for managing the requisitioning function.
• SupplierContact: string
  Read Only: true

  Maximum Length: 4000

  Name of the person representing the supplier with regards to communication with the buying company.
• SupplierContactEmail: string
  Read Only: true

  Maximum Length: 2000

  Email of the supplier contact.
• SupplierContactFax: string
  Read Only: true

  Maximum Length: 255

  Fax details of the supplier contact.
• SupplierContactId: integer
  Read Only: true

  Value that uniquely identifies the supplier contact.
• SupplierContactPhone: string
  Read Only: true

  Maximum Length: 255

  Phone number of the supplier contact.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier location from where goods or services are purchased.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "RequisitionBUAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierContactPhone":{
            "maxLength":"255",
            "type":"string",
            "description":"Phone number of the supplier contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit responsible for managing the requisitioning function.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "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
        },
        "SupplierContactEmail":{
            "maxLength":"2000",
            "type":"string",
            "description":"Email of the supplier contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitioningBUName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit responsible for managing the requisitioning function.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierContactFax":{
            "maxLength":"255",
            "type":"string",
            "description":"Fax details of the supplier contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : shoppingCatalogSmartFormDetails-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Contains one of the following values: true or false. If true then the attachment is shared. If false, then it is not shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Login that the user used when creating the document.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the record.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the document from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path of the folder from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the document version from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

  Date when the contents of the attachment are no longer valid.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attached file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the attached file.
• FileUrl: string
  Title: File Url

  Uniform resource locator of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

  Content type of the attached file.
• UploadedFileLength: integer
  Title: File Size

  Size of the attached file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  Contents of the text file that's attached.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) of the topology manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  Uniform resource locator of the web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login that the user used when creating the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) of the 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":"Uniform resource locator of the web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the document 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
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies 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
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the document.",
            "nullable":true,
            "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the document version from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Uniform resource locator of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true then the attachment is shared. If false, then it is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents of the attachment are no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path of the folder from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Contents of the text file that's attached.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : shoppingCatalogSmartFormDetails-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.
• InformationTemplate: string
  Title: Information Template

  Read Only: true

  Maximum Length: 250

  Name of the information template.
• InformationTemplateAssignmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies information template assignment with the smart form.
• InformationTemplateDisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 250

  Display name of the information template.
• InformationTemplateId: integer (int64)
  Read Only: true

  Value that uniquely identifies the information template.
• InstructionText: string
  Title: Instruction Text

  Read Only: true

  Maximum Length: 250

  Instructional text for how to use the additional information required for ordering goods or services.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the smart form.

{
    "type":"object",
    "properties":{
        "InformationTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the information template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "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
            }
        },
        "InformationTemplateDisplayName":{
            "title":"Display Name",
            "maxLength":"250",
            "type":"string",
            "description":"Display name of the information template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
            }
        },
        "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
            }
        }
    }
}

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"
    }
}

Back to Top