Jump to

• Request
• Response

Get all contract templates applied to business documents

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/templateUsages

Request

Path Parameters

• supplierNegotiationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations 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
• 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:
  
  

  • PrimaryKey: Finds the contract template applied to a business document using the specified primary key.
    Finder Variables:
    • DocumentId; integer; Unique identifier for the business document that's associated with a contract template.
    • DocumentType; string; Document type of the business document that's associated with a contract template.
    • MajorVersion; integer; Major version number of the contract template usage.
    • TemplateId1; integer; Unique identifier for the contract template used in the business document.
• 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:
  

  • AuthoringPartyCode; string; Code indicating which contract party authored the contract terms.
  • ContractExpertEnabled; string; Indicates whether the contract expert feature can be used after the contract template is applied to a purchasing document. Valid values are Y and N.
  • ContractSourceCode; string; Specifies the current source of the contract terms for the purchasing document. Valid values are STRUCTURED and ATTACHED.
  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the record was created.
  • Description; string; Description of the contract template used in the purchasing document.
  • DocumentId; integer; Unique identifier of the purchasing document associated with a contract template.
  • DocumentNumber; string; Number of the purchasing document associated with a contract template.
  • DocumentType; string; Code representing the document type of the purchasing document associated with a contract template.
  • DocumentTypeName; string; Document type of the purchasing document associated with a contract template.
  • LastUpdateDate; string; Date and time when the record was last updated.
  • LastUpdatedBy; string; Sign-in of the user who last updated the record.
  • MajorVersion; integer; Major version number of the contract template applied to a purchasing document.
  • SimpleContractYn; string; Indicates whether the contract is simple.
  • SourceCode; string; Source of the template. Valid values are STRUCTURED and CONTRACT_FORM.
  • TemplateId; number; Unique identifier of the contract template used in the purchasing document.
  • TemplateId1; integer; Unique identifier of the contract template used in the purchasing document.
  • TemplateName; string; Name of the contract template used in the purchasing document.
  • VersionType; string; Version type of the contract template. Valid values are Current, Amendment, or History.
• 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

• 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 : supplierNegotiations-templateUsages

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiations-templateUsages-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierNegotiations-templateUsages-item-response

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

Type: object

Show Source

• AuthoringPartyCode: string
  Title: Authoring Party

  Maximum Length: 30

  Code indicating which contract party authored the contract terms.
• ContractExpertEnabled: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract expert feature can be used after the contract template is applied to a purchasing document. Valid values are Y and N.
• ContractSourceCode: string
  Title: Contract Source

  Maximum Length: 30

  Specifies the current source of the contract terms for the purchasing document. Valid values are STRUCTURED and ATTACHED.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the record was created.
• Description: string
  Read Only: true

  Maximum Length: 2000

  Description of the contract template used in the purchasing document.
• DocumentId: integer
  Unique identifier of the purchasing document associated with a contract template.
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 150

  Number of the purchasing document associated with a contract template.
• DocumentType: string
  Title: Document Type

  Maximum Length: 30

  Code representing the document type of the purchasing document associated with a contract template.
• DocumentTypeName: string
  Title: Document Type

  Document type of the purchasing document associated with a contract template.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Sign-in of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Major version number of the contract template applied to a purchasing document.
• SimpleContractText: string (byte)
  HTML content of the simple contract terms.
• SimpleContractYn: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SourceCode: string
  Read Only: true

  Maximum Length: 80

  Source of the template. Valid values are STRUCTURED and CONTRACT_FORM.
• TemplateId: number
  Title: Contract Terms Template

  Unique identifier of the contract template used in the purchasing document.
• TemplateId1: integer (int64)
  Read Only: true

  Unique identifier of the contract template used in the purchasing document.
• TemplateName: string
  Title: Current Contract Terms Template

  Read Only: true

  Maximum Length: 240

  Name of the contract template used in the purchasing document.
• VersionType: string
  Maximum Length: 1

  Version type of the contract template. Valid values are Current, Amendment, or History.

{
    "type":"object",
    "properties":{
        "AuthoringPartyCode":{
            "title":"Authoring Party",
            "maxLength":30,
            "type":"string",
            "description":"Code indicating which contract party authored the contract terms.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContractExpertEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract expert feature can be used after the contract template is applied to a purchasing document. Valid values are Y and N.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractSourceCode":{
            "title":"Contract Source",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the current source of the contract terms for the purchasing document. Valid values are STRUCTURED and ATTACHED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Unique identifier of the purchasing document associated with a contract template.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":150,
            "type":"string",
            "description":"Number of the purchasing document associated with a contract template.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":30,
            "type":"string",
            "description":"Code representing the document type of the purchasing document associated with a contract template.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentTypeName":{
            "title":"Document Type",
            "type":"string",
            "description":"Document type of the purchasing document associated with a contract template.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Sign-in of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Major version number of the contract template applied to a purchasing document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimpleContractText":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SimpleContractYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCode":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Valid values are STRUCTURED and CONTRACT_FORM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Contract Terms Template",
            "type":"number",
            "description":"Unique identifier of the contract template used in the purchasing document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TemplateId1":{
            "type":"integer",
            "description":"Unique identifier of the contract template used in the purchasing document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Current Contract Terms Template",
            "maxLength":240,
            "type":"string",
            "description":"Name of the contract template used in the purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionType":{
            "maxLength":1,
            "type":"string",
            "description":"Version type of the contract template. Valid values are Current, Amendment, or History.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top