Uploading an Attachment
Function
Upload an attachment for SDKs to use.
URI
POST /v2/servicerequest/accessorys/json-format-content
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  | 
     
|---|---|---|---|
| 
        accessory_name  | 
      
        No  | 
      
        String  | 
      
        Specifies the file name. Minimum length: 1 Maximum length: 512  | 
     
| 
        accessory_from  | 
      
        No  | 
      
        String  | 
      
        Specifies the file source. Minimum length: 1 Maximum length: 32  | 
     
| 
        upload_type  | 
      
        No  | 
      
        Integer  | 
      
        Specifies the upload type. Minimum value: 0 Maximum value: 1  | 
     
| 
        accessory_data  | 
      
        Yes  | 
      
        String  | 
      
        Specifies the file content in Base64 format. Minimum length: 1 Maximum length: 9223372036854775807  | 
     
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        accessory_id  | 
      
        String  | 
      
        Specifies the attachment ID. Minimum length: 1 Maximum length: 64  | 
     
Request Example
POST https://{endpoint}/v2/servicerequest/accessorys/json-format-content
{
  "accessory_name" : "test",
  "accessory_from" : "message",
  "upload_type" : 1,
  "accessory_data" : "Base64"
}
 Example Response
Status code: 200
Upload succeeded. ID of the attachment is returned.
{
  "accessory_id" : "123456"
}
 Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        Upload succeeded. ID of the attachment is returned.  | 
     
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.