Attachment Read Method
The Attachment API provides access to an attachment.
Attachment Read allows the user to acquire the data of the Attachment that meets the specified conditions.
|
GET |
https://{Request URI Host}/v1/attachment?partition=[value]&requestType=[value]&resource=[value]&resourceId=[value]&id=[value]&count=[value]&start=[value] |
|---|
Scope
The access privilege required for Attachment Read is as follows:
attachment_r, process_r, resume_r, candidate_r, job_r, recruiter_r, client_r
Input Variables
When using the GET or POST Method, the parameter of the HTTP Header must be specified with a value. For details, see HTTP Header.
The following shows the Parameters that can be specified:
Each Parameter is an AND condition for search.
| Required | Parameter | Definition |
|---|---|---|
| ● | partition | Specify a numerical value for the Partition Id. To check the Partition Id that can be accessed, acquire the information using Partition Read. |
| ● | requestType | Specify whether to acquire the Content. 0: Base64 encoded data are added to the <Content> tag. 1: The <Content> tag is not included. |
| ● | resource | Specify the Resource you want to acquire. For information on the values that can be specified, see Resource List. |
| ー | resourceId | The item that Indicates the Id of the of the relevant Resource. The Id of Candidate, Job or other Resources applies to this. |
| ー | id | Specify the Id of the Attachment you want to acquire. |
| ー | count | Specify the number of records of data to acquire. The range of the values that can be specified is between 1 and 200. If nothing is specified, 10 is assumed to be specified. |
| ー | start | The start index of the data to acquire. Specify a numerical value of 0 or larger. If nothing is specified, 0 is assumed to be specified. |
Result Values
When the processing is successfully completed, “200” is returned to the Response Header as the HTTP status, and the value that is described in Output Values can be acquired.
If an error occurs, a value other than 200 is returned.
Output Values
The output value can be acquired in the XML format. No optional Field can be handled by the Attachment API.
| Tag | Definition |
|---|---|
| Attachment | Route element including the Attachment that meets the conditions. The number of acquired data is set for Count, and the index of the acquired data is set for Start. Start is the index beginning with 0. Lists every Attachment as the Item elements. |
| Total | Attribute of the Attachment. Indicates the total number of records that can be acquired under the specified search conditions. |
| Count | Attribute of the Attachment. Indicates the number of records of the data acquired this time. |
| Start | Attribute of the Attachment. Indicates the start index of the data acquired this time. |
| Code | The code that represents the processing result. For details, see Result Code List. |
| Item | Indicates one piece of Attachment information. |
| Id | Id of the Attachment |
| Resource | The item that Indicates the relevant Resource. For the value of the Resource, see Resource List. |
| ResourceId | Indicates the Id of the record of the relevant Resource. |
| ContentType | Indicates the type of the Content data. Usually, this type is the same as the Mime Type. For details, see Attachment - Mime Type List. |
| FileName | Name of the attachment file. |
| Content | Bease64 encoded file. |
Attachment Read Sample
This sample code shown below is not encoded. In the case of an actual Request, encoding/decoding may be necessary depending on the content.
The following sample acquires the file that is attached to the record with Resume ID = 10006.
|
Input Parameter https://{Request URI Host}/v1/attachment?partition=999999&requestType=0&resource=17&resourceId=10006 |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |