How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenProject File Links API

The File Links API from OpenProject — 14 operation(s) for file links.

OpenProject File Links API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include File Links. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 14 paths, and defines 23 schemas. It is described by OpenAPI 3.1.2, at version 3.

Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.

19 operations 14 paths 23 schemas 2 DELETE11 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3
Base URL
https://community.openproject.org/api/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

OpenProject File Links API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 2 DELETE, 11 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

File Links 19
GET
/api/v3/project_storages
Gets a list of project storages
list_project_storages 1 param → 200400
GET
/api/v3/project_storages/{id}
Gets a project storage
get_project_storage 1 param → 200404
GET
/api/v3/project_storages/{id}/open
Open the project storage
open_project_storage 1 param → 303403404
GET
/api/v3/storages/{id}/open
Open the storage
open_storage 1 param → 303404
GET
/api/v3/file_links/{id}
Gets a file link.
view_file_link 1 param → 200404
DELETE
/api/v3/file_links/{id}
Removes a file link.
delete_file_link 1 param → 200403404
GET
/api/v3/file_links/{id}/open
Creates an opening uri of the linked file.
open_file_link 2 params → 303404
GET
/api/v3/file_links/{id}/download
Creates a download uri of the linked file.
download_file_link 1 param → 303404
GET
/api/v3/storages
Get Storages
list_storages → 200400
POST
/api/v3/storages
Creates a storage.
create_storage body → 201400403406415422
GET
/api/v3/storages/{id}
Get a storage
get_storage 1 param → 200404
PATCH
/api/v3/storages/{id}
Update a storage
update_storage 1 param body → 200403404
DELETE
/api/v3/storages/{id}
Delete a storage
delete_storage 1 param → 204403404
GET
/api/v3/storages/{id}/files
Gets files of a storage.
get_storage_files 2 params → 200400404
POST
/api/v3/storages/{id}/files/prepare_upload
Preparation of a direct upload of a file to the given storage.
prepare_storage_file_upload 1 param body → 201400403404500
POST
/api/v3/storages/{id}/folders
Creation of a new folder
create_storage_folder 1 param body → 201400403404
POST
/api/v3/storages/{id}/oauth_client_credentials
Creates an oauth client credentials object for a storage.
create_storage_oauth_credentials 1 param body → 201403404
POST
/api/v3/work_packages/{id}/file_links
Creates file links.
create_work_package_file_link 1 param body → 201400403404406415422
GET
/api/v3/work_packages/{id}/file_links
Gets all file links of a work package
list_work_package_file_links 2 params → 200403404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are StorageReadModel (14 properties), OAuthApplicationReadModel (10 properties), FileLinkOriginDataModel (8 properties), FileLinkReadModel (7 properties). Each schema is shown below with its type and property counts.

CollectionModel
object
4 properties 4 required
Link
object
7 properties 1 required
FileLinkCollectionWriteModel
object
1 property 1 required
FileLinkReadModel
object
7 properties
ProjectStorageModel
object
6 properties 5 required
CollectionLinks
object
1 property 1 required
StorageReadModel
object
14 properties 4 required
StorageFileUploadLinkModel
object
2 properties 2 required
PaginatedCollectionModel
OAuthClientCredentialsWriteModel
object
2 properties 2 required
StorageWriteModel
object
6 properties
StorageFilesModel
object
5 properties 5 required
OAuthApplicationReadModel
object
10 properties 6 required
FileLinkOriginDataModel
object
8 properties 2 required
OAuthClientCredentialsReadModel
object
7 properties 5 required
ProjectStorageCollectionModel
FileLinkCollectionReadModel
ErrorResponse
object
4 properties 3 required
FileLinkWriteModel
object
2 properties 2 required
StorageFileModel
StorageFolderWriteModel
object
2 properties 2 required
StorageFileUploadPreparationModel
object
3 properties 3 required
StorageCollectionModel

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openproject-file-links-api-openapi.yml Raw ↑

Other APIs OpenProject publishes across the network.

OpenProject Actions & Capabilities API
OpenProject Activities API
OpenProject Attachments API
OpenProject Budgets API
OpenProject Categories API
OpenProject Collections API
OpenProject Configuration API
OpenProject Custom actions API
OpenProject Custom Field Items API
OpenProject Custom Fields API
OpenProject Custom Options API
OpenProject Documents API
Where this information came from

This is an independent, third-party profile of OpenProject File Links API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.