mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
ea2c0ce229
* 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
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# WebscriptApi
|
|
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**executeWebScript**](WebscriptApi.md#executeWebScript) | | execute WebScript
|
|
|
|
|
|
<a name="executeWebScript"></a>
|
|
# **executeWebScript**
|
|
> executeWebScript(httpMethod, scriptPath, scriptArgs, contextRoot, servicePath)
|
|
|
|
|
|
For mor information about web scripts read the [Wiki](https://wiki.alfresco.com/wiki/Web_Scripts) and the [Wiki with Web ScriptsExamples](https://wiki.alfresco.com/wiki/Web_Scripts_Examples)
|
|
|
|
> Anatomy of a Web Script URI **http(s)://(host):(port)/(contextPath)/(servicePath)/(scriptPath)?(scriptArgs)**
|
|
A Web Script is simply a service bound to a URI which responds to HTTP methods such as GET, POST, PUT and DELETE. While using the same underlying code, there are broadly two kinds of Web Scripts.
|
|
|
|
### Parameters
|
|
Name | Type | Description | Notes|
|
|
------------- | ------------- | ------------- | -------------
|
|
**httpMethod** | **String**| possible value GET, POST, PUT and DELETE ||
|
|
**scriptPath** | **String**|path to Web Script (as defined by Web Script)||
|
|
**scriptArgs** | **String**|arguments to pass to Web Script ||
|
|
**contextRoot** | **String**|path where application is deployed default value 'alfresco'||
|
|
**servicePath** | **String**|path where Web Script service is mapped default value 'service'||
|
|
**postBody** | **Object**|post body||
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
|
|
//Call a GET on a Web Scripts available at the following URIs: http://127.0.01:8080/alfresco/service/mytasks
|
|
|
|
this.alfrescoJsApi.core.webscriptApi.executeWebScript('GET', 'mytasks').then(function (data) {
|
|
console.log('Data received form http://127.0.01:8080/alfresco/service/mytasks' + data);
|
|
}, function (error) {
|
|
console.log('Error' + error);
|
|
});
|
|
|
|
//Call a GET on a Web Scripts available at the following URIs: http://127.0.01:8080/share/service/mytasks
|
|
|
|
this.alfrescoJsApi.core.webscriptApi.executeWebScript('GET', 'mytasks', null, 'share').then(function (data) {
|
|
console.log('Data received form http://127.0.01:8080/share/service/mytasks' + data);
|
|
}, function (error) {
|
|
console.log('Error' + error);
|
|
});
|
|
|
|
//Call a GET on a Web Scripts available at the following URIs: http://127.0.01:8080/share/differentServiceSlug/mytasks
|
|
|
|
this.alfrescoJsApi.core.webscriptApi.executeWebScript('GET', 'mytasks', null, 'share', 'differentServiceSlug').then(function (data) {
|
|
console.log('Data received form http://127.0.01:8080/share/differentServiceSlug/mytasks' + data);
|
|
}, function (error) {
|
|
console.log('Error' + error);
|
|
});
|
|
|
|
```
|
|
|