-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
taken in all content from the word document
- Loading branch information
frank
committed
Nov 22, 2023
1 parent
8afafa0
commit b05fab5
Showing
4 changed files
with
153 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
documentation/src/content/docs/reference/06 sending-files.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: Sending files through the import API | ||
description: Learn how to send files to ahead | ||
tableOfContents: false | ||
--- | ||
|
||
In order to send a file to ahead, a field needs to be specified in the people profile definition to accept a certain kind of file. | ||
|
||
```json | ||
{ | ||
"name": "salary", | ||
"fieldType": "File", | ||
"source": "Api", | ||
"isList": true | ||
} | ||
``` | ||
|
||
In this example, files of type **salary** can be sent to ahead. The filename of the file(s) being sent via a | ||
`multipart/form-data` request needs to follow a certain structure: | ||
|
||
```text | ||
{userIdentifier}__{fieldName}__{fileName}.pdf | ||
``` | ||
|
||
Note the **<u>2</u>** underscores between the pieces of information. Following the example, | ||
the following would be a valid file name: | ||
|
||
```text | ||
joe@company.com__salary__March 2023.pdf | ||
``` | ||
|
||
It would upload a new file named **March 2023.pdf** under the **salary** category for the user with the UPN joe@company.com | ||
|
||
You can send up to **50 files** per multipart request. | ||
|
||
:::danger | ||
Regardless of whether you send 50 files on a request or, please note that the | ||
total size of the request should **not** exceed **104 Megabytes**. | ||
The request will not be processed if it exceeds that size. | ||
::: |