vPlan
  1. Attachment
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Schedule
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Update Single Collection
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • Attachment
        • Retrieve Attachment List
          GET
        • Upload New Attachment
          POST
        • Add New Attachment Link
          POST
        • Retrieve Single Attachment
          GET
        • Remove Single Attachment
          DELETE
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Attachment

Add New Attachment Link

POST
/collection/{collection_id}/attachment
Attachment
Add a link as new Attachment and store it for this collection
Possible usages are:
large files (e.g. cad files)
better version control, e.g. prevent having old versions in vPlan
enhanced security
NOTE
It is expected that links to an external system are accessible from any device or location, especially the mobile apps.
TIP
Because oAuth is authenticated by a user, this is the user creating this attachment.
For integrations that are not user specific, customers are advised to create a separate user specifically for this integration.

Request

Path Params
collection_id
string 
required
Query Params
show
string 
optional
limit the response to show only specific properties, see show & hide for more info
Example:
id,updated_at
hide
string 
optional
hide properties from the response, see show & hide for more info
Example:
created_at,updated_at
Header Params
x-api-key
string 
required
Default:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}
Body Params application/json
filename
string 
optional
Filename of the attachment
file
string <uri>
optional
URI the file can be accessed on
type
enum<string> 
optional
Allowed values:
fs.mostwanted.iootherFS clone
checksum
string <sha256>
optional
Checksum of the file. This checksum is a SHA-256 hash of the contents of the file.
signature
string 
optional
Signature of the file, required for FS related url's, otherwise for informational purposes
bytes
integer 
optional
Size of the attachment in bytes
thumbnail
string <uri>
optional
URL the thumbnail can be accessed on
WARNING
If thumbnail_type is fs.mostwanted.io the url will expire over time
thumbnail_type
enum<string> 
optional
Allowed value:
fs.mostwanted.io
thumbnail_checksum
string <sha256>
optional
Checksum of the thumbnail. This checksum is a SHA-256 hash of the contents of the thumbnail.
thumbnail_signature
string 
optional
Signature of the thumbnail, required for FS related url's, otherwise for informational purposes
thumbnail_bytes
integer 
optional
Size of the attachment in bytes
collection_id
string <uuid>
required
Unique identifier of the Collection
user_id
string <uuid>
required
Unique identifier of the User
Example
{
    "filename": "string",
    "file": "http://example.com",
    "type": "fs.mostwanted.io",
    "checksum": "string",
    "signature": "string",
    "bytes": 0,
    "thumbnail": "http://example.com",
    "thumbnail_type": "fs.mostwanted.io",
    "thumbnail_checksum": "string",
    "thumbnail_signature": "string",
    "thumbnail_bytes": 0,
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vplan.com/v1/collection//attachment' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filename": "string",
    "file": "http://example.com",
    "type": "fs.mostwanted.io",
    "checksum": "string",
    "signature": "string",
    "bytes": 0,
    "thumbnail": "http://example.com",
    "thumbnail_type": "fs.mostwanted.io",
    "thumbnail_checksum": "string",
    "thumbnail_signature": "string",
    "thumbnail_bytes": 0,
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}'

Responses

🟢201Created
application/json
Body
id
string <uuid>
read-onlyoptional
Unique identifier
filename
string 
optional
Filename of the attachment
file
string <uri>
optional
URI the file can be accessed on
type
enum<string> 
optional
Allowed values:
fs.mostwanted.iootherFS clone
checksum
string <sha256>
optional
Checksum of the file. This checksum is a SHA-256 hash of the contents of the file.
signature
string 
optional
Signature of the file, required for FS related url's, otherwise for informational purposes
bytes
integer 
optional
Size of the attachment in bytes
thumbnail
string <uri>
optional
URL the thumbnail can be accessed on
WARNING
If thumbnail_type is fs.mostwanted.io the url will expire over time
thumbnail_type
enum<string> 
optional
Allowed value:
fs.mostwanted.io
thumbnail_checksum
string <sha256>
optional
Checksum of the thumbnail. This checksum is a SHA-256 hash of the contents of the thumbnail.
thumbnail_signature
string 
optional
Signature of the thumbnail, required for FS related url's, otherwise for informational purposes
thumbnail_bytes
integer 
optional
Size of the attachment in bytes
collection_id
string <uuid>
required
Unique identifier of the Collection
user_id
string <uuid>
required
Unique identifier of the User
external_ref
string  | null 
read-onlyoptional
Third-party reference of the object, for informational purposes only
Example:
fb1033a2ed70
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "filename": "string",
    "file": "http://example.com",
    "type": "fs.mostwanted.io",
    "checksum": "string",
    "signature": "string",
    "bytes": 0,
    "thumbnail": "http://example.com",
    "thumbnail_type": "fs.mostwanted.io",
    "thumbnail_checksum": "string",
    "thumbnail_signature": "string",
    "thumbnail_bytes": 0,
    "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z"
}
🟠412412
🟠422Unprocessable Content
🟠404Not Found
🟠401Not Logged In
Previous
Upload New Attachment
Next
Retrieve Single Attachment
Built with