mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
This commit is contained in:
36
lib/js-api/docs/calling-custom-endpoints.md
Normal file
36
lib/js-api/docs/calling-custom-endpoints.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Calling Custom Endpoints
|
||||
|
||||
Content service and process service has two different clients:
|
||||
|
||||
- AlfrescoJsApi.ProcessClient
|
||||
- AlfrescoJsApi.ContentClient
|
||||
|
||||
Both clients expose a method ***callApi**
|
||||
|
||||
```typescript
|
||||
function callApi(
|
||||
path: string,
|
||||
httpMethod: string,
|
||||
pathParams?: any,
|
||||
queryParams?: any,
|
||||
headerParams?: any,
|
||||
formParams?: any,
|
||||
bodyParam?: any,
|
||||
contentTypes?: string[],
|
||||
accepts?: string[],
|
||||
returnType?: any,
|
||||
contextRoot?: string,
|
||||
responseType?: string
|
||||
): Promise<any> {};
|
||||
```
|
||||
|
||||
If you want call your custom rest point in one of those two service use the corresponding client.
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
alfrescoJsApi.bpmClient.callApi(
|
||||
'/api/enterprise/app-version', 'GET',
|
||||
{}, {}, {}, {}, {}, ['application/json'], ['application/json'], {'String': 'String'}
|
||||
)
|
||||
```
|
Reference in New Issue
Block a user