Offer a document category to an entity type

POST/lokta-lms/api/v1/documentcategories

Mandatory fields: entityType, documentCategoryId

Optional fields: documentTagIds, orderPosition, active

documentTagIds may be empty; a category configured before its tags are known is a legitimate state, and
being able to express it is why the mapping is two tables rather than one triple.

One category may be offered to one entity type once; a second attempt is a 403.

Request body application/json

documentCategoryIdinteger · int64 · required

entityTypestring · required

activeboolean · optional

documentTagIdsarray · optional

orderPositioninteger · int32 · optional

Responses

200OK

Response fields

resourceIdinteger · int64 · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

curl -X POST \ 'https://default.lokta.tech/lokta-lms/api/v1/documentcategories' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "documentCategoryId": 1, "entityType": "string", "active": true, "documentTagIds": [ 1 ], "orderPosition": 1 }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/documentcategories", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "documentCategoryId": 1, "entityType": "string", "active": True, "documentTagIds": [ 1 ], "orderPosition": 1 }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/documentcategories", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "documentCategoryId": 1, "entityType": "string", "active": true, "documentTagIds": [ 1 ], "orderPosition": 1 }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/documentcategories")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "documentCategoryId": 1, "entityType": "string", "active": true, "documentTagIds": [ 1 ], "orderPosition": 1 } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "documentCategoryId": 1, "entityType": "string", "active": true, "documentTagIds": [ 1 ], "orderPosition": 1 }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/documentcategories", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))