MCP
A2ABatch Upload Employee Document
curl --request POST \
--url https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '
{
"items": [
{
"name": "weather-forecast",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
"category_id": "6530",
"path": "/path/to/file",
"confidential": {
"value": "true",
"source_value": "public"
},
"category": {
"value": "reports",
"source_value": "550e8400-e29b-41d4-a716-446655440000"
}
}
]
}
'import requests
url = "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch"
payload = { "items": [
{
"name": "weather-forecast",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
"category_id": "6530",
"path": "/path/to/file",
"confidential": {
"value": "true",
"source_value": "public"
},
"category": {
"value": "reports",
"source_value": "550e8400-e29b-41d4-a716-446655440000"
}
}
] }
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
name: 'weather-forecast',
file_format: {value: 'pdf', source_value: 'application/pdf'},
content: 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE',
category_id: '6530',
path: '/path/to/file',
confidential: {value: 'true', source_value: 'public'},
category: {value: 'reports', source_value: '550e8400-e29b-41d4-a716-446655440000'}
}
]
})
};
fetch('https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'name' => 'weather-forecast',
'file_format' => [
'value' => 'pdf',
'source_value' => 'application/pdf'
],
'content' => 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE',
'category_id' => '6530',
'path' => '/path/to/file',
'confidential' => [
'value' => 'true',
'source_value' => 'public'
],
'category' => [
'value' => 'reports',
'source_value' => '550e8400-e29b-41d4-a716-446655440000'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"weather-forecast\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n },\n \"content\": \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n \"category_id\": \"6530\",\n \"path\": \"/path/to/file\",\n \"confidential\": {\n \"value\": \"true\",\n \"source_value\": \"public\"\n },\n \"category\": {\n \"value\": \"reports\",\n \"source_value\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"name\": \"weather-forecast\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n },\n \"content\": \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n \"category_id\": \"6530\",\n \"path\": \"/path/to/file\",\n \"confidential\": {\n \"value\": \"true\",\n \"source_value\": \"public\"\n },\n \"category\": {\n \"value\": \"reports\",\n \"source_value\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"name\": \"weather-forecast\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n },\n \"content\": \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n \"category_id\": \"6530\",\n \"path\": \"/path/to/file\",\n \"confidential\": {\n \"value\": \"true\",\n \"source_value\": \"public\"\n },\n \"category\": {\n \"value\": \"reports\",\n \"source_value\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 202,
"message": "Batch operation accepted",
"timestamp": "2021-01-01T01:01:01.000Z",
"errors": [
[
"Missing field: name"
],
[],
[]
]
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Batch Upload Employee Document
POST
/
unified
/
hris
/
employees
/
{id}
/
documents
/
upload
/
batch
Batch Upload Employee Document
curl --request POST \
--url https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '
{
"items": [
{
"name": "weather-forecast",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
"category_id": "6530",
"path": "/path/to/file",
"confidential": {
"value": "true",
"source_value": "public"
},
"category": {
"value": "reports",
"source_value": "550e8400-e29b-41d4-a716-446655440000"
}
}
]
}
'import requests
url = "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch"
payload = { "items": [
{
"name": "weather-forecast",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
"category_id": "6530",
"path": "/path/to/file",
"confidential": {
"value": "true",
"source_value": "public"
},
"category": {
"value": "reports",
"source_value": "550e8400-e29b-41d4-a716-446655440000"
}
}
] }
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
name: 'weather-forecast',
file_format: {value: 'pdf', source_value: 'application/pdf'},
content: 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE',
category_id: '6530',
path: '/path/to/file',
confidential: {value: 'true', source_value: 'public'},
category: {value: 'reports', source_value: '550e8400-e29b-41d4-a716-446655440000'}
}
]
})
};
fetch('https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'items' => [
[
'name' => 'weather-forecast',
'file_format' => [
'value' => 'pdf',
'source_value' => 'application/pdf'
],
'content' => 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE',
'category_id' => '6530',
'path' => '/path/to/file',
'confidential' => [
'value' => 'true',
'source_value' => 'public'
],
'category' => [
'value' => 'reports',
'source_value' => '550e8400-e29b-41d4-a716-446655440000'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"weather-forecast\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n },\n \"content\": \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n \"category_id\": \"6530\",\n \"path\": \"/path/to/file\",\n \"confidential\": {\n \"value\": \"true\",\n \"source_value\": \"public\"\n },\n \"category\": {\n \"value\": \"reports\",\n \"source_value\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"name\": \"weather-forecast\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n },\n \"content\": \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n \"category_id\": \"6530\",\n \"path\": \"/path/to/file\",\n \"confidential\": {\n \"value\": \"true\",\n \"source_value\": \"public\"\n },\n \"category\": {\n \"value\": \"reports\",\n \"source_value\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"name\": \"weather-forecast\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n },\n \"content\": \"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE\",\n \"category_id\": \"6530\",\n \"path\": \"/path/to/file\",\n \"confidential\": {\n \"value\": \"true\",\n \"source_value\": \"public\"\n },\n \"category\": {\n \"value\": \"reports\",\n \"source_value\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 202,
"message": "Batch operation accepted",
"timestamp": "2021-01-01T01:01:01.000Z",
"errors": [
[
"Missing field: name"
],
[],
[]
]
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
The account identifier
Path Parameters
Body
application/json
The batch of items to create
Show child attributes
Show child attributes
Was this page helpful?
⌘I