Attachment

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

Uploading One or More Attachment Files for a Tag

Upload one or more attachments to a tag.

API Call: POST/client/{clientId}/tag/{tagId}/attachment

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment

URL Parameters

User Roles

The user role that can upload one or more attachment files for a tag is:

• The owner of the specified tag ONLY

API Parameters

cURL

cURL Sample uploadattachment_tag Snippet

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: multipart/form-data"
  -F "[email protected]<ATTACHMENTFILE>;type=<ATTACHMENTTYPE>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

[
  {
    "uuid": "<UUID>",
    "filename": "<FILENAME>",
    "contentType": "<CONTENTTYPE>",
    "contentLength": <CONTENTLENGTH>
  }
]

HTTP Status Codes

200 Sample Response

[
  {
    "filename": "string",
    "uuid": "string",
    "contentType": "string",
    "contentLength": 0
  }
]

Listing Attachments on the Given Tag

List a tag's attachments.

API Call: GET/client/{clientId}/tag/{tagId}/attachment

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment

URL Parameters

User Roles

The user role that can list attachments on the given tag is:

• Dependent upon if the caller has access to the tag

API Parameters

cURL

cURL Sample listattachment_tag Snippet

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

[
  {
    "uuid": "<UUID>",
    "filename": "<FILENAME>",
    "contentType": "<CONTENTTYPE>",
    "contentLength": <CONTENTLENGTH>
  }
]

HTTP Status Codes

200 Sample Response

[
  {
    "filename": "string",
    "uuid": "string",
    "contentType": "string",
    "contentLength": 0
  }
]

Fetching Tag Attachment by UUID

Fetch tag attachment by tag attachment UUID.

API Call: GET/client/{clientId}/tag/{tagId}/attachment/{attachmentUUID}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment/<ATTACHMENTUUID>

URL Parameters

User Roles

The user role that can fetch attachments by UUID is:

• Dependent upon if the caller has access to the tag

API Parameters

cURL

cURL Sample fetchattachment_uuid Snippet

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment/<ATTACHMENTUUID>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

This is a test.

HTTP Status Codes

Try changing from application/octet-stream to application/json or vice versa.

Removing an Attachment File for a Tag

Remove an attachment file from a tag.

API Call: DELETE/client/{clientId}/tag/{tagId}/attachment/{attachmentUUID}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment/<ATTACHMENTUUID>

URL Parameters

User Roles

The user role that can remove an attachment file from a tag is:

• Only the owner of the specified tag can removes attached files

API Parameters

cURL

cURL Sample remove_tagattachment Snippet

curl -X DELETE "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment/<ATTACHMENTUUID>"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

[
  "string"
]

HTTP Status Codes

200 Sample Response

[
  "string"
]

Fetching Tag Attachment Metadata

Fetch tag attachment metadata.

API Call: GET/client/{clientId}/tag/{tagId}/attachment/{attachmentUUID}/meta

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment/<ATTACHMENTUUID>/meta

URL Parameters

User Roles

The user role that can fetch tag attachment metadata is:

• Dependent upon whether the caller has access to the tag.

API Parameters

cURL

cURL Sample fetch_tagAttachmentMetadata Snippet

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/tag/<TAGID>/attachment/<ATTACHMENTUUID>/meta"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Response Parameters

Sample Response

[
  {
    "uuid": "<UUID>",
    "filename": "<FILENAME>",
    "contentType": "<CONTENTTYPE>",
    "contentLength": <CONTENTLENGTH>
  }
]

HTTP Status Codes

200 Sample Response

{
  "filename": "string",
  "uuid": "string",
  "contentType": "string",
  "contentLength": 0
}