Jump to

• Request
• Response

Update a contract key term

patch

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/contractKeyTermExtracts/{Id}/child/contractKeyTerms/{Id4}

Request

Path Parameters

• Id(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• Id4(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClassificationCode: string
  Title: Classification

  Maximum Length: 150

  The classification code of the contract key term.
• contractKeyTermCitations: array Contract Key Term Citations
  Title: Contract Key Term Citations

  Contract key term citation is used to view the citations for each of the contract key terms.
• Measure: string
  Title: Measure

  Maximum Length: 30

  The measure of the contract key term.
• ObjectVersionNumber: integer (int32)
  The object version number of the contract key term.
• SourceFromId: integer (int64)
  The source from identifier of the contract key term.
• UpdatedValue: string
  Title: Updated Value

  Maximum Length: 4000

  The updated value of the contract key term.
• UpdatedValueDate: string (date-time)
  The updated value date of the contract key term.
• UpdatedValueNumber: number
  The updated value number of the contract key term.

{
    "type":"object",
    "properties":{
        "UpdatedValueDate":{
            "type":"string",
            "description":"The updated value date of the contract key term.",
            "format":"date-time",
            "nullable":true
        },
        "UpdatedValue":{
            "title":"Updated Value",
            "maxLength":4000,
            "type":"string",
            "description":"The updated value of the contract key term.",
            "nullable":true
        },
        "SourceFromId":{
            "type":"integer",
            "description":"The source from identifier of the contract key term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contract key term.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ClassificationCode":{
            "title":"Classification",
            "maxLength":150,
            "type":"string",
            "description":"The classification code of the contract key term.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdatedValueNumber":{
            "type":"number",
            "description":"The updated value number of the contract key term.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":6
            }
        },
        "Measure":{
            "title":"Measure",
            "maxLength":30,
            "type":"string",
            "description":"The measure of the contract key term.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "contractKeyTermCitations":{
            "title":"Contract Key Term Citations",
            "type":"array",
            "description":"Contract key term citation is used to view the citations for each of the contract key terms.",
            "items":{
                "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-patch-request"
            }
        }
    }
}

Nested Schema : Contract Key Term Citations

Type: array

Title: Contract Key Term Citations

Contract key term citation is used to view the citations for each of the contract key terms.

Show Source

• Array of: object contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-patch-request

{
    "title":"Contract Key Term Citations",
    "type":"array",
    "description":"Contract key term citation is used to view the citations for each of the contract key terms.",
    "items":{
        "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-patch-request"
    }
}

Nested Schema : contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-patch-request

Type: object

Show Source

• AttachedDocumentFileURL: string
  The attached document file or URL associated with the contract key term citation.
• AttachedDocumentId: integer
  The attached document identifier of the contract key term citation.
• AttachedFileName: string
  Title: Document Name

  The attached file name associated with the contract key term citation.
• Id: integer (int64)
  The identifier of the contract key term citation.
• ObjectVersionNumber: integer (int32)
  The object version number of the contract key term citation.
• SequenceNumber: integer
  The sequence number of the contract key term citation.

{
    "type":"object",
    "properties":{
        "AttachedFileName":{
            "title":"Document Name",
            "type":"string",
            "description":"The attached file name associated with the contract key term citation.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"The attached document identifier of the contract key term citation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contract key term citation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "AttachedDocumentFileURL":{
            "type":"string",
            "description":"The attached document file or URL associated with the contract key term citation.",
            "nullable":true,
            "x-queryable":false
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number of the contract key term citation.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The identifier of the contract key term citation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : contracts-contractKeyTermExtracts-contractKeyTerms-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Status

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the contract key term is active or not.
• ClassificationCode: string
  Title: Classification

  Maximum Length: 150

  The classification code of the contract key term.
• contractKeyTermCitations: array Contract Key Term Citations
  Title: Contract Key Term Citations

  Contract key term citation is used to view the citations for each of the contract key terms.
• ContractKeyTermsCode: string
  Maximum Length: 80

  The code of the contract key term.
• DnzChrId: integer (int64)
  The parent contract identifier of the contract key term.
• Id: integer (int64)
  The identifier of the contract key term.
• KeyTermCode: string
  Read Only: true

  Maximum Length: 80

  The key term code of the contract key term.
• KeyTermExtractId: integer (int64)
  The extract identifier of the contract key term.
• KeyTermGroup: string
  Title: Group

  Read Only: true

  Maximum Length: 30

  The group of the contract key term.
• KeyTermGroupName: string
  Title: Group

  Read Only: true

  Maximum Length: 80

  The group name of the contract key term.
• KeyTermName: string
  Title: Key Term

  Read Only: true

  Maximum Length: 300

  The name of the contract key term.
• KeyTermOutputType: string
  Read Only: true

  Maximum Length: 30

  The output type of the contract key term.
• links: array Links
  Title: Links

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

  The major version of the contract key term.
• Measure: string
  Title: Measure

  Maximum Length: 30

  The measure of the contract key term.
• ObjectVersionNumber: integer (int32)
  The object version number of the contract key term.
• PromptId: integer (int64)
  The prompt identifier of the contract key term.
• RawValue: string
  Title: Extracted Value

  Maximum Length: 4000

  The raw value of the contract key term.
• SourceFromId: integer (int64)
  The source from identifier of the contract key term.
• UpdatedValue: string
  Title: Updated Value

  Maximum Length: 4000

  The updated value of the contract key term.
• UpdatedValueDate: string (date-time)
  The updated value date of the contract key term.
• UpdatedValueNumber: number
  The updated value number of the contract key term.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"The major version of the contract key term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KeyTermName":{
            "title":"Key Term",
            "maxLength":300,
            "type":"string",
            "description":"The name of the contract key term.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedValueDate":{
            "type":"string",
            "description":"The updated value date of the contract key term.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "KeyTermGroupName":{
            "title":"Group",
            "maxLength":80,
            "type":"string",
            "description":"The group name of the contract key term.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedValue":{
            "title":"Updated Value",
            "maxLength":4000,
            "type":"string",
            "description":"The updated value of the contract key term.",
            "nullable":true,
            "x-queryable":true
        },
        "KeyTermExtractId":{
            "type":"integer",
            "description":"The extract identifier of the contract key term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceFromId":{
            "type":"integer",
            "description":"The source from identifier of the contract key term.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractKeyTermsCode":{
            "maxLength":80,
            "type":"string",
            "description":"The code of the contract key term.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdatedValueNumber":{
            "type":"number",
            "description":"The updated value number of the contract key term.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":6
            },
            "x-queryable":true
        },
        "KeyTermCode":{
            "maxLength":80,
            "type":"string",
            "description":"The key term code of the contract key term.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract key term is active or not.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "DnzChrId":{
            "type":"integer",
            "description":"The parent contract identifier of the contract key term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contract key term.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Classification",
            "maxLength":150,
            "type":"string",
            "description":"The classification code of the contract key term.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KeyTermGroup":{
            "title":"Group",
            "maxLength":30,
            "type":"string",
            "description":"The group of the contract key term.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Measure":{
            "title":"Measure",
            "maxLength":30,
            "type":"string",
            "description":"The measure of the contract key term.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "KeyTermOutputType":{
            "maxLength":30,
            "type":"string",
            "description":"The output type of the contract key term.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The identifier of the contract key term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "contractKeyTermCitations":{
            "title":"Contract Key Term Citations",
            "type":"array",
            "description":"Contract key term citation is used to view the citations for each of the contract key terms.",
            "items":{
                "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-response"
            }
        },
        "PromptId":{
            "type":"integer",
            "description":"The prompt identifier of the contract key term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RawValue":{
            "title":"Extracted Value",
            "maxLength":4000,
            "type":"string",
            "description":"The raw value of the contract key term.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Contract Key Term Citations

Type: array

Title: Contract Key Term Citations

Contract key term citation is used to view the citations for each of the contract key terms.

Show Source

• Array of: object contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-response

{
    "title":"Contract Key Term Citations",
    "type":"array",
    "description":"Contract key term citation is used to view the citations for each of the contract key terms.",
    "items":{
        "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-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 : contracts-contractKeyTermExtracts-contractKeyTerms-contractKeyTermCitations-item-response

Type: object

Show Source

• AttachedDocumentFileURL: string
  The attached document file or URL associated with the contract key term citation.
• AttachedDocumentId: integer
  The attached document identifier of the contract key term citation.
• AttachedFileName: string
  Title: Document Name

  The attached file name associated with the contract key term citation.
• Citation: string
  Maximum Length: 4000

  The citation of the contract key term.
• ContractKeyTermId: integer (int64)
  The identifier of the contract key term.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the contract key term citation.
• CreationDate: string (date-time)
  Read Only: true

  The date when the contract key term citation was created.
• DocumentIdentifier: string
  Maximum Length: 120

  The document identifier of the contract key term citation.
• Id: integer (int64)
  The identifier of the contract key term citation.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the contract key term citation.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the contract key term citation.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The last update login of the contract key term citation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number of the contract key term citation.
• SequenceNumber: integer
  The sequence number of the contract key term citation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contract key term citation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachedFileName":{
            "title":"Document Name",
            "type":"string",
            "description":"The attached file name associated with the contract key term citation.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the contract key term citation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contract key term citation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachedDocumentFileURL":{
            "type":"string",
            "description":"The attached document file or URL associated with the contract key term citation.",
            "nullable":true,
            "x-queryable":false
        },
        "DocumentIdentifier":{
            "maxLength":120,
            "type":"string",
            "description":"The document identifier of the contract key term citation.",
            "nullable":false,
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"The attached document identifier of the contract key term citation.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contract key term citation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number of the contract key term citation.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractKeyTermId":{
            "type":"integer",
            "description":"The identifier of the contract key term.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Citation":{
            "maxLength":4000,
            "type":"string",
            "description":"The citation of the contract key term.",
            "nullable":false,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The identifier of the contract key term citation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the contract key term citation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The last update login of the contract key term citation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Links

contractKeyTermCitations

Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/contractKeyTermExtracts/{Id}/child/contractKeyTerms/{Id4}/child/contractKeyTermCitations

Parameters:

• Id2: $request.path.Id2
• Id4: $request.path.Id4
• contractsUniqID: $request.path.contractsUniqID

Contract key term citation is used to view the citations for each of the contract key terms.

Back to Top