Jump to

• Request
• Response

Get one information template

get

/fscmRestApi/resources/11.13.18.05/informationTemplates/{informationTemplatesUniqID}

Request

Path Parameters

• informationTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Information Templates resource and used to uniquely identify an instance of Information Templates. The client should not generate the hash key value. Instead, the client should query on the Information Templates collection resource in order to navigate to a specific instance of Information Templates to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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

Type: object

Show Source

• AttachmentCategory: string
  Maximum Length: 30

  Category that classifies the attachment.
• AttributeList: string
  Title: Name

  Maximum Length: 80

  List of attributes included in the information template.
• categoryAssociations: array Category Associations
  Title: Category Associations

  Associations of categories used in an information template. For example, an information template can include related category links for classification.
• CreatedBy: string
  Maximum Length: 64

  User who created the information template.
• CreationDate: string (date-time)
  The date when the information template was created.
• InactiveDate: string (date)
  The date when the information template becomes inactive.
• InformationTemplateDisplayName: string
  Maximum Length: 250

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

  Unique identifier of the information template.
• InformationTemplateName: string
  Title: Information Template

  Maximum Length: 250

  Name of the information template.
• InstructionText: string
  Maximum Length: 250

  Instruction text for users to know how to use the information template.
• itemAssociations: array Item Associations
  Title: Item Associations

  Associations of items used in an information template. For example, an information template can include master items.
• LastUpdateDate: string (date-time)
  The date when the information template was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  User who last updated the information template.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Business unit in which the information template is created.
• ProcurementBUId: integer (int64)
  Identifier of the business unit in which the information template is created.

{
    "type":"object",
    "properties":{
        "AttachmentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"Category that classifies the attachment.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AttributeList":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"List of attributes included in the information template.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"default",
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the information template.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the information template was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InactiveDate":{
            "type":"string",
            "description":"The date when the information template becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InformationTemplateDisplayName":{
            "maxLength":250,
            "type":"string",
            "description":"Display name of the information template.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InformationTemplateId":{
            "type":"integer",
            "description":"Unique identifier of the information template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InformationTemplateName":{
            "title":"Information Template",
            "maxLength":250,
            "type":"string",
            "description":"Name of the information template.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InstructionText":{
            "maxLength":250,
            "type":"string",
            "description":"Instruction text for users to know how to use the information template.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the information template was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the information template.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcurementBU":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Business unit in which the information template is created.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Identifier of the business unit in which the information template is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "categoryAssociations":{
            "title":"Category Associations",
            "type":"array",
            "description":"Associations of categories used in an information template. For example, an information template can include related category links for classification.",
            "items":{
                "$ref":"#/components/schemas/informationTemplates-categoryAssociations-item-response"
            }
        },
        "itemAssociations":{
            "title":"Item Associations",
            "type":"array",
            "description":"Associations of items used in an information template. For example, an information template can include master items.",
            "items":{
                "$ref":"#/components/schemas/informationTemplates-itemAssociations-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Category Associations

Type: array

Title: Category Associations

Associations of categories used in an information template. For example, an information template can include related category links for classification.

Show Source

• Array of: object informationTemplates-categoryAssociations-item-response

{
    "title":"Category Associations",
    "type":"array",
    "description":"Associations of categories used in an information template. For example, an information template can include related category links for classification.",
    "items":{
        "$ref":"#/components/schemas/informationTemplates-categoryAssociations-item-response"
    }
}

Nested Schema : Item Associations

Type: array

Title: Item Associations

Associations of items used in an information template. For example, an information template can include master items.

Show Source

• Array of: object informationTemplates-itemAssociations-item-response

{
    "title":"Item Associations",
    "type":"array",
    "description":"Associations of items used in an information template. For example, an information template can include master items.",
    "items":{
        "$ref":"#/components/schemas/informationTemplates-itemAssociations-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 : informationTemplates-categoryAssociations-item-response

Type: object

Show Source

• AssociationId: integer (int64)
  Read Only: true

  Unique identifier of the category association.
• CategoryId: integer (int64)
  Unique identifier for the category associated with the information template.
• CategoryName: string
  Maximum Length: 2400

  Name of the category assigned to the information template.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description of the category associated with the information template.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the category association was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssociationId":{
            "type":"integer",
            "description":"Unique identifier of the category association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier for the category associated with the information template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the category assigned to the information template.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "CategoryId1"
                ]
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the category associated with the information template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the category association was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":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 : 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 : informationTemplates-itemAssociations-item-response

Type: object

Show Source

• AssociationId: integer (int64)
  Unique identifier of the item association.
• Description: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item associated with the information template.
• ItemId: integer (int64)
  Unique identifier of the item.
• ItemNumber: string
  Maximum Length: 300

  Value that uniquely identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the item association was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssociationId":{
            "type":"integer",
            "description":"Unique identifier of the item association.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item associated with the information template.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier of the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Value that uniquely identifies the item.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the item association was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":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

categoryAssociations

Operation: /fscmRestApi/resources/11.13.18.05/informationTemplates/{informationTemplatesUniqID}/child/categoryAssociations

Parameters:

• informationTemplatesUniqID: $request.path.informationTemplatesUniqID

Associations of categories used in an information template. For example, an information template can include related category links for classification.

itemAssociations

Operation: /fscmRestApi/resources/11.13.18.05/informationTemplates/{informationTemplatesUniqID}/child/itemAssociations

Parameters:

• informationTemplatesUniqID: $request.path.informationTemplatesUniqID

Associations of items used in an information template. For example, an information template can include master items.

Back to Top