new Raptor(config)
Raptor SDK wrapper
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Object | configuration object |
Members
client
Return a API client instance
client
Return a API client instance
find
Search for Service Objects.
Example parameters:
1) free-form query: { query: "some params" }
2) field params:
{
name: "Object Name",
description: "optional description"
customFields: {
param1: "value"
}
}
find
Search for Service Objects.
Example parameters:
1) free-form query: { query: "some params" }
2) field params:
{
name: "Object Name",
description: "optional description"
customFields: {
param1: "value"
}
}
Methods
create(wo) → {Promise}
Create a Service Object from an object or a WebObject
Parameters:
| Name | Type | Description |
|---|---|---|
wo |
Object | ServiceObject compatible definition object or WebObject |
Returns:
Promise for the future ServiceObject created
- Type
- Promise
create(wo) → {Promise}
Create a Service Object from an object or a WebObject
Parameters:
| Name | Type | Description |
|---|---|---|
wo |
Object | ServiceObject compatible definition object or WebObject |
Returns:
Promise for the future ServiceObject created
- Type
- Promise
delete(objectId) → {Promise}
Delete a Service Object by id
Parameters:
| Name | Type | Description |
|---|---|---|
objectId |
String | ServiceObject id |
Returns:
Promise for the future result of the operation
- Type
- Promise
delete(objectId) → {Promise}
Delete a Service Object by id
Parameters:
| Name | Type | Description |
|---|---|---|
objectId |
String | ServiceObject id |
Returns:
Promise for the future result of the operation
- Type
- Promise
list() → {Promise}
Retrieve all the Service Objects from a given user (identified by the Authorization header).
Returns:
- Type
- Promise
list() → {Promise}
Retrieve all the Service Objects from a given user (identified by the Authorization header).
Returns:
- Type
- Promise
load(id) → {Promise}
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | ServiceObject id |
Returns:
A promise with the created SO
- Type
- Promise
load(id) → {Promise}
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | ServiceObject id |
Returns:
A promise with the created SO
- Type
- Promise