Jump to

• Request
• Response

Get all contract key term extracts

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/contractKeyTermExtracts

Request

Path Parameters

• 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.

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 contact key term extracts based on a specified identifier.
    Finder Variables:
    • Id :The identifier for the contract key term extract.
• 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:
  

  • ClassificationDate; string; The classification data of the contract key term extract.
  • CreatedBy; string; The user who created the contract key term extract.
  • CreationDate; string; The date when the contract key term extract was created.
  • DnzChrId; integer; The parent contract identifier of the contract key term extract.
  • Id; integer; The identifier of the contract key term extract.
  • LastUpdateDate; string; The last updated date of the contract key term extract.
  • LastUpdateLogin; string; The last updated login of the contract key term extract.
  • LastUpdatedBy; string; The user who last updated the contract key term extract.
  • LatestFlag; boolean; Indicates whether the contract key term extract is the latest.
  • LookupCode; string; The lookup code of the contract key term extract.
  • LookupType; string; The lookup type of the contract key term extract.
  • MajorVersion; integer; The major version of the contract key term extract.
  • ObjectVersionNumber; integer; The object version number of the contract key term extract.
  • RequestStatus; string; The request status of the contract key term extract.
  • RequestStatusMeaning; string; The request status meaning of the contract key term extract.
  • ResultDate; string; The result date of the contract key term extract.
  • SubmitDate; string; The date when the contract key term extract was submitted.
  • Submitter; string; The user who submitted the contract key term extract.
• 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 : contracts-contractKeyTermExtracts

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/contracts-contractKeyTermExtracts-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Type: object

Show Source

• ClassificationDate: string (date-time)
  Title: Classification Date

  The classification data of the contract key term extract.
• contractKeyTermExtractDocuments: array Contract Key Term Extract Documents
  Title: Contract Key Term Extract Documents

  Contract key term extract document is used to view the documents consumed by key term extraction process.
• contractKeyTerms: array Contract Key Terms
  Title: Contract Key Terms

  Contract key terms is used to view the key term values extracted by the process.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the contract key term extract.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the contract key term extract was created.
• DnzChrId: integer (int64)
  The parent contract identifier of the contract key term extract.
• Id: integer (int64)
  The identifier of the contract key term extract.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last updated date of the contract key term extract.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the contract key term extract.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The last updated login of the contract key term extract.
• LatestFlag: boolean
  Title: Last Submitted Process Flag

  Maximum Length: 1

  Indicates whether the contract key term extract is the latest.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  The lookup code of the contract key term extract.
• LookupType: string
  Title: Lookup Type

  Read Only: true

  Maximum Length: 30

  The lookup type of the contract key term extract.
• MajorVersion: integer (int64)
  Title: Contract Version

  The major version of the contract key term extract.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number of the contract key term extract.
• RequestStatus: string
  Title: Status

  Maximum Length: 40

  The request status of the contract key term extract.
• RequestStatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The request status meaning of the contract key term extract.
• ResultDate: string (date-time)
  Title: Completion Date

  The result date of the contract key term extract.
• SubmitDate: string (date-time)
  Title: Submitted Date

  The date when the contract key term extract was submitted.
• Submitter: string
  Title: Submitted By

  Maximum Length: 64

  The user who submitted the contract key term extract.
• SubmitterDisplayName: string
  Title: Submitted By

  The display name of the user who submitted the contract key term extract.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contract key term extract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Contract Version",
            "type":"integer",
            "description":"The major version of the contract key term extract.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the contract key term extract was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitterDisplayName":{
            "title":"Submitted By",
            "type":"string",
            "description":"The display name of the user who submitted the contract key term extract.",
            "nullable":true,
            "x-queryable":false
        },
        "contractKeyTermExtractDocuments":{
            "title":"Contract Key Term Extract Documents",
            "type":"array",
            "description":"Contract key term extract document is used to view the documents consumed by key term extraction process.",
            "items":{
                "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTermExtractDocuments-item-response"
            }
        },
        "contractKeyTerms":{
            "title":"Contract Key Terms",
            "type":"array",
            "description":"Contract key terms is used to view the key term values extracted by the process.",
            "items":{
                "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTerms-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contract key term extract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type of the contract key term extract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date when the contract key term extract was submitted.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LatestFlag":{
            "title":"Last Submitted Process Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contract key term extract is the latest.",
            "nullable":false,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code of the contract key term extract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The request status meaning of the contract key term extract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationDate":{
            "title":"Classification Date",
            "type":"string",
            "description":"The classification data of the contract key term extract.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Submitter":{
            "title":"Submitted By",
            "maxLength":64,
            "type":"string",
            "description":"The user who submitted the contract key term extract.",
            "nullable":false,
            "x-queryable":true
        },
        "DnzChrId":{
            "type":"integer",
            "description":"The parent contract identifier of the contract key term extract.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number of the contract key term extract.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The identifier of the contract key term extract.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last updated date of the contract key term extract.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The last updated login of the contract key term extract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "title":"Status",
            "maxLength":40,
            "type":"string",
            "description":"The request status of the contract key term extract.",
            "nullable":false,
            "x-queryable":true
        },
        "ResultDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The result date of the contract key term extract.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Contract Key Term Extract Documents

Type: array

Title: Contract Key Term Extract Documents

Contract key term extract document is used to view the documents consumed by key term extraction process.

Show Source

• Array of: object contracts-contractKeyTermExtracts-contractKeyTermExtractDocuments-item-response

{
    "title":"Contract Key Term Extract Documents",
    "type":"array",
    "description":"Contract key term extract document is used to view the documents consumed by key term extraction process.",
    "items":{
        "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTermExtractDocuments-item-response"
    }
}

Nested Schema : Contract Key Terms

Type: array

Title: Contract Key Terms

Contract key terms is used to view the key term values extracted by the process.

Show Source

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

{
    "title":"Contract Key Terms",
    "type":"array",
    "description":"Contract key terms is used to view the key term values extracted by the process.",
    "items":{
        "$ref":"#/components/schemas/contracts-contractKeyTermExtracts-contractKeyTerms-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-contractKeyTermExtractDocuments-item-response

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  The attached document identifier of the contract key term extract document.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

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

  The last updated date of the contract key term extract document.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  The last update login of the contract key term extract document.
• 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 extract document.
• ParentId: integer (int64)
  The parent identifier of the contract key term extract document.
• ParentType: string
  Maximum Length: 40

  The parent type of the contract key term extract document.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contract key term extract document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentId":{
            "type":"integer",
            "description":"The parent identifier of the contract key term extract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the contract key term extract document 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 extract document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"The attached document identifier of the contract key term extract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contract key term extract document.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParentType":{
            "maxLength":40,
            "type":"string",
            "description":"The parent type of the contract key term extract document.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The identifier of the contract key term extract document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentIdentifier":{
            "maxLength":120,
            "type":"string",
            "description":"The document identifier of the contract key term extract document.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last updated date of the contract key term extract document.",
            "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 extract document.",
            "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."
        }
    }
}

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

Back to Top