Wegalvanize Planning files API
A planning file (also known as a reference file) is a supporting document that relates to a project or framework. Planning files typicallycontain information associated with the planning phase of a project or framework.> **Note:**Planning files located in such resources can be accessed using the API:> * In projects that have an "active" state> * In frameworksLearn more about planning files.
Wegalvanize Planning files API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Planning files. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.
Requests are made against a single base URL, {protocol}://{server}/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Wegalvanize Planning files API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (oauth2) (bearerToken).
By default, every request must be authenticated.
bearerToken— HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a safe and secure way to access data, while pr…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
A planning file (also known as a reference file) is a supporting document that relates to a project or framework. Planning files typically contain information associated with the…
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), GetPlanningFilesResponse (2 properties), UpdatePlanningFileRequest (1 property), CreatePlanningFileRequest (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Wegalvanize 12
Other APIs Wegalvanize publishes across the network.