Create Opportunity File (stream)

const url = 'https://api.coperniq.io/v1/opportunities/opportunityId/files/upload';
const form = new FormData();
form.append('file', 'string');
const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};
options.body = form;
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "name": "string",
  "downloadUrl": "string",
  "metaData": {
    "acl": "string",
    "size": 1,
    "userId": 1,
    "mimeType": "string",
    "extention": "string",
    "originalName": "string",
    "generatedName": "string",
    "gps": {},
    "thumbnailUrl": "string",
    "thumbnailName": "string",
    "requestFileName": "string"
  }
}

Upload a file to an opportunity using multipart/form-data

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdstringRequired

Query parameters

namestringOptional

Optional file name to store

content_typestringOptional

Optional MIME type to associate with the file

phase_instance_idintegerOptional

Optional phase instance id to associate with the file

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Response

Successful response

idinteger

File identifier

namestring

File name

downloadUrlstring

URL to download the file

metaDataobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error