Download custom export excel file¶
Download Microsoft NCE custom export excel file.
Prerequisites¶
Credentials as described in Authentication
An export queue item id as described in Get export queue
C#¶
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.Exports.Download(token, exportQueueItemId);;
Request¶
Request Syntax:
Method |
Request URI |
|---|---|
GET |
https://api.crayon.com/api/v1/exports/{id}/download/ |
Request Parameters:
Name |
Type |
Description |
Required |
|---|---|---|---|
id |
int |
The export queue item id |
YES |
Request Headers:
The following HTTP request headers are supported
Header |
Type |
Description |
|---|---|---|
Authorization |
string |
Required. The authorization token in the form Bearer <token>. |
Accept |
string |
Specifies the response type, “application/json” or “application/octet-stream” |
Request Example:
GET $"https://api.crayon.com/api/v1/exports/{id}/download/"
Accept : application/json
Authorization : Bearer < Token >
Response¶
If successful, a zip file is returned. The FileContent property contains byte array with the excel file.
Response success and error codes:
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.
Error Codes |
Description |
|---|---|
200 Ok |
The request has succeeded. |
401 Unauthorized |
The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. |