Viewing the Latest Agreement

Updated on 2025-02-10 GMT+08:00

View PDF

Function

View the details of the latest agreement.

URI

GET /v2/servicerequest/agreements/published-agreement

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
agreement_type	No	String	Indicates the agreement type. Minimum length: 1 Maximum length: 32

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000
X-Language	No	String	Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default. Some internationalization information, such as the service ticket type and name, is displayed based on the language environment. Minimum length: 1 Maximum length: 32
X-Time-Zone	No	String	Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default. Time-related data is processed based on the time zone of the environment. Minimum length: 1 Maximum length: 32

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
case_agreement	AgreementVO object	Specifies the attachment restrictions.

**Table 4** AgreementVO
Parameter	Type	Description
id	String	Specifies the agreement ID. Minimum length: 1 Maximum length: 11
agreement_name	String	Specifies the agreement name. Minimum length: 1 Maximum length: 128
agreement_type	String	Indicates the agreement type. Minimum length: 1 Maximum length: 32
agreement_type_name	String	Specifies the agreement type name. Minimum length: 1 Maximum length: 128
content	String	Specifies the agreement content. Minimum length: 1 Maximum length: 2147483647
version	Integer	Specifies the version. Minimum value: 0 Maximum value: 2147483647

Example Request

GET https://{endpoint}/v2/servicerequest/agreements/published-agreement?agreement_type=5

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "case_agreement" : {
    "id" : "123",
"agreement_name": " Create Service Ticket",
    "agreement_type" : "0",
"agreement_type_name": " Create Service Ticket",
    "content" : "content",
    "version" : "1.0.0"
  }
}