Signing the Agreement
Function
Sign the agreement.
URI
POST /v2/servicerequest/agreements/{id}/signed
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
Integer |
Specifies the agreement ID. Minimum value: 1 Maximum value: 32 |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
relation_id |
No |
String |
Specifies the association ID. Minimum length: 1 Maximum length: 32 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
agreement_signed_record_id |
Integer |
Specifies the signing record ID. Minimum value: 0 Maximum value: 2147483647 |
Example Request
GET https://{endpoint}/v2/servicerequest/agreements/0/signed { "relation_id" : "relationId" }
Response Example
Status code: 200
Code 200 is returned if the operation is successful.
{ "agreement_signed_record_id" : "1" }
Status Codes
Status Code |
Description |
---|---|
200 |
Code 200 is returned if the operation is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.