Attachment

An Attachment.

Get an attachment

Get an attachment.

SecurityJWT

Request

path Parameters

attachment

required

string or integer

The id/hash of the attachment.

query Parameters

disposition

string or null

Default: "attachment"

The content-disposition for the requested file.

For attachment the file should be downloaded, forinline the file can be displayed.

Enum: null "attachment" "inline"

Responses

200

Successful operation

404

Not Found

get/attachment/{attachment}

Request samples

curl

Response samples

application/json

{"success": false,
"error": {"status": 404,
"message": "Oops! The requested file could not be found.",
"code": 0
},
"timestamp": 1660209950641
}

Update an attachment

Update an attachment.

SecurityJWT

Request

path Parameters

attachment

required

string or integer

The id/hash of the attachment.

Request Body schema: application/json

A JSON object containing attachment information

name

required

string <= 1000 characters

The attachment name.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/attachment/{attachment}

Request samples

Payload
curl

application/json

{"name": "falcon_contract.pdf"
}

Response samples

application/json

{"success": true,
"hash": "309da39c208b9cca615e8363eb7e56b5274c0c06",
"data": {"id": 26,
"hash": "8a46a135d200f5fba5603f9cb1201dbccb01df2a",
"name": "falcon_contract.pdf",
"extension": "pdf",
"mime": "application/pdf",
"size": 527267,
"checksum": "3cfd50c8f73e1ef11fdac50a979586e2626610c6d7d8c8e4a9e404869554c8cc",
"created_time": "2022-08-11T09:17:25.000000Z",
"modified_time": "2022-08-11T09:17:42.000000Z",
"modified_user_time": "2022-08-11T09:17:42.000000Z",
"model": "Attachment",
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1660209462494
}

Delete an attachment

Delete an attachment.

SecurityJWT

Request

path Parameters

attachment

required

string or integer

The id/hash of the attachment.

Responses

200

Successful operation

404

Not Found

delete/attachment/{attachment}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1660209903077
}

Copy an attachment

Copy an attachment into a tree element.

SecurityJWT

Request

path Parameters

attachment

required

string or integer

The id/hash of the attachment.

Request Body schema: application/json

A JSON object containing attachment information.

non-empty

measure	string or integer The new parent measure of the attachment.
measure_package	string or integer The new parent measure package of the attachment.
project	string or integer The new parent project of the attachment.
program	string or integer The new parent program of the attachment.

Responses

200

Successful operation

404

Not Found

post/attachment/{attachment}/copy

Request samples

Payload
curl

application/json

{"project": "583bf59445f18e7bf566020aa8134ddfa7c79113"
}

Response samples

application/json

{"success": true,
"hash": "97d170e1550eee4afc0af065b78cda302a97674c",
"data": { },
"timestamp": 1733494665418
}

Relocate an attachment

Relocate an attachment to a new parent.

SecurityJWT

Request

path Parameters

attachment

required

string or integer

The id/hash of the attachment.

Request Body schema: application/json

A JSON object containing attachment information.

non-empty

measure	string or integer The new parent measure of the attachment.
measure_package	string or integer The new parent measure package of the attachment.
project	string or integer The new parent project of the attachment.
program	string or integer The new parent program of the attachment.

Responses

200

Successful operation

404

Not Found

put/attachment/{attachment}/relocate

Request samples

Payload
curl

application/json

{"measure_package": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5"
}

Response samples

application/json

{"success": true,
"hash": "b3f40b2ebdeb9e690256e61aca14bc0df121e5a4",
"data": {"id": 26,
"hash": "8a46a135d200f5fba5603f9cb1201dbccb01df2a",
"name": "falcon_contract.pdf",
"extension": "pdf",
"mime": "application/pdf",
"size": 527267,
"checksum": "3cfd50c8f73e1ef11fdac50a979586e2626610c6d7d8c8e4a9e404869554c8cc",
"created_time": "2022-08-11T09:17:25.000000Z",
"modified_time": "2024-12-06T14:29:41.000000Z",
"modified_user_time": "2024-12-06T14:29:41.000000Z",
"model": "Attachment",
"attachable": {"id": 1,
"hash": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5",
"name": "Working Capital",
"description": "The working capital measures of stock reduction and turnover are aimed at a sustainable reduction of cash and cash equivalents tied up in current assets and should create the necessary resources for our company to be able to make important investments in the coming year under its own steam.",
"targets": "",
"assumptions": "",
"miscellaneous": "",
"paused": false,
"locked": false,
"guarded": false,
"created_time": "2022-06-27T09:48:06.000000Z",
"modified_time": "2022-06-27T09:48:06.000000Z",
"modified_user_time": "2022-06-27T09:48:06.000000Z",
"model": "MeasurePackage"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1733495381822
}

Restore an attachment

Restore an attachment.

SecurityJWT

Request

path Parameters

attachment

required

string or integer

The id/hash of the attachment.

Responses

200

Successful operation

404

Not Found

put/attachment/{attachment}/restore

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1660210113096
}

➔ Next to Audit log