Files
Get a list of files for your environment or upload a file.
Use the Files resource to return a list of files associated with your org. You can also upload a file via a multi-part request with an input stream for the file.
Syntax
- Resource
-
- Availability
- v1.0
- Formats
- REST
- HTTP methods
-
GET
Gets a list of files for your environment.
POST
Uploads a file via a multi-part request with an input stream for the file.
- Authentication
- OAuth
- Request parameters
-
Parameter Description baseURI baseURI for the API gateway. Different regions have different values. Call the Data Job API lists the values.
For example: na.api-salesforce.com/datamanager/
apiVersion Version of the DJ API to use. The current version is v1.0.
For example: v1.0
- Query parameters
-
- resultsPerPage
- Number of results per page to return.
- fileType
- Filters files by file type. Valid values are configuration, datasets, export, or logs.
- page
- The page of results to return. The page value index starts at 1. For example, If you specify resultsPerPage=10 and request page=1, you get results 1–10. If you request page=2, you get results 11–20.
- GET Request headers
-
- x-sfdc-domain
- Specifies the instance_url returned in the authentication token.
- accept
- Specifies the type. For this resource, application/json is required.
- authorization
- Specifies the authorization token.
- POST Request headers
-
- x-sfdc-domain
- Specifies the instance_url returned in the authentication token.
- Content-type
- Specifies the content type. For this resource, multipart/form-data is required.
- authorization
- Specifies the authorization token.
- Request and Response Bodies
- Consult the appropriate version of the Data Jobs RAML Spec.
Example
- GET Request
- Gets a list of all the files stored in file staging for Customer 360 Data Manager.
-
- GET Response
-
- POST Request
- Uploads CRM_Lead.csv from a local directory.
-
- POST Response
-