Attachment

An Attachment.

Get all attachments

Get all attachments of the authenticated user of the authenticated hub.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the attachment list for a measure.

measure_package
string or integer

Filter the attachment list for a measure package.

project
string or integer

Filter the attachment list for a project.

program
string or integer

Filter the attachment list for a program.

created_user
string or integer

Filter the attachment list for a created user.

modified_user
string or integer

Filter the attachment list for a modified user.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/attachment
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "1280b87bda7d9bd2c08ac39717ee157e7dcdd403",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1772729918210
}
Get an attachment
Get an attachment.
Returns either the attachment object or the binary file content, depending on the API server endpoint.
SecurityJWT 
Request 
path Parameters
attachment
required
string or integer
The id/hash of the attachment.


 
query Parameters
disposition
string
 Default:  "attachment"
The content-disposition for the requested file.
Only applicable when downloading a file from the Storage API. For attachment the file should be downloaded, forinline the file can be displayed.
 Enum: "attachment" "inline"  
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


get/attachment/{attachment}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "1280b87bda7d9bd2c08ac39717ee157e7dcdd403",
  • "data": {
    },
  • "timestamp": 1772729918210
}
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 
application/json
{
  • "name": "falcon_contract.pdf"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "309da39c208b9cca615e8363eb7e56b5274c0c06",
  • "data": {
    },
  • "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 
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 
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 
application/json
{
  • "measure_package": "7ce83d4d4d933305a5410a7311a6a6f133f37dd5"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "b3f40b2ebdeb9e690256e61aca14bc0df121e5a4",
  • "data": {
    },
  • "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 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1660210113096
}
➔ Next to Audit log