Create

Create a new attachment. Assumes the file is already uploaded to S3 through the upload service.

Request

This endpoint expects an object.

s3PathstringRequired

titlestringRequired

descriptionstringRequired

propertiesmap from strings to stringsRequired

labelsset of stringsRequired

workspacestringOptional

The workspace in which to create the attachment. If not provided, the attachment will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

Response

This endpoint returns an object.

ridstring

Unique resource identifier for an Attachment

titlestring

s3Pathstring

fileTypestring

descriptionstring

createdBystring

propertiesmap from strings to strings

labelsset of strings

createdAtdatetime

isArchivedboolean

1	curl -X POST https://api.gov.nominal.io/api/attachments/v1/attachments \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"s3Path": "s3Path",
6	"title": "title",
7	"description": "description",
8	"properties": {
9	"properties": "properties"
10	},
11	"labels": [
12	"labels"
13	]
14	}'

1	{
2	"rid": "rid",
3	"title": "title",
4	"s3Path": "s3Path",
5	"fileType": "fileType",
6	"description": "description",
7	"createdBy": "createdBy",
8	"properties": {
9	"properties": "properties"
10	},
11	"labels": [
12	"labels"
13	],
14	"createdAt": "2024-01-15T09:30:00Z",
15	"isArchived": true
16	}

Headers

Request

Response