Skip to content

Commit 31d1773

Browse files
Merge pull request #10479 from NielsKunst/custom-fields-api-doc
Update project category api documentation
2 parents 7e634b5 + 58513c3 commit 31d1773

File tree

2 files changed

+638
-0
lines changed

2 files changed

+638
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "Project Category API"
3+
url: /apidocs-mxsdk/apidocs/project-category-api/
4+
type: swagger
5+
description: "The Project Category API manages your project categories."
6+
weight: 100
7+
restapi: true
8+
---
9+
10+
## Introduction
11+
12+
The Mendix Project Category API allows you to create, edit or delete your project categories.
13+
14+
## Authentication {#authentication}
15+
16+
Authentication for the Project Category API uses a personal access token (PAT).
17+
18+
### Generating a PAT {#generate}
19+
20+
For details on how to generate a PAT, refer to the [Personal Access Tokens](/mendix-profile/user-settings/#pat) section of *User Settings*.
21+
22+
Select the appropriate scopes, depending on the endpoints that need to be invoked. Refer to the [API Reference](#api-reference) for more information on which scopes to use in which endpoints.
23+
24+
Store the generated value somewhere safe so you can use it to authorize your API calls.
25+
26+
### Using the PAT
27+
28+
Each request must contain an `Authorization` header with the value `MxToken {GENERATED_PAT}`. For example:
29+
30+
```http
31+
GET /companies/{:companyId}/categories HTTP/1.1
32+
Authorization: MxToken 7LJE…vk
33+
```
34+
35+
## API Reference{#api-reference}
36+
37+
{{< swaggerui-disable-try-it-out src="/openapi-spec/categories-v1.yaml" >}}

0 commit comments

Comments
 (0)