Memos
Gate to access memos information.
Parameters
Name |
In |
Type |
Required |
Description |
orgId |
path |
string |
true |
organization name |
limit |
query |
integer(int64) |
false |
Limit the elements numbers in response |
offset |
query |
integer(int64) |
false |
Move the pointer to the first element in response |
create-from |
query |
string(date) |
false |
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01 |
create-to |
query |
string(date) |
false |
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01 |
Request example
1
2
3
4
5
|
curl -X GET https://customers.sta.masstack.com/v3/orgs/telco/memos?limit='100'&offset='100'&create-from='2020-01-01'&create-to='2020-12-31' \
-H "Accept: application/json" \
-H "x-auth-roles: API_KEY"
|
Parameters
Name |
In |
Type |
Required |
Description |
orgId |
path |
string |
true |
organization name |
hosttable |
path |
string |
true |
Name of table where this memo record is assignedSee HostTable. |
limit |
query |
integer(int64) |
false |
Limit the elements numbers in response |
offset |
query |
integer(int64) |
false |
Move the pointer to the first element in response |
create-from |
query |
string(date) |
false |
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01 |
create-to |
query |
string(date) |
false |
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01 |
Request example
1
2
3
4
5
|
curl -X GET https://customers.sta.masstack.com/v3/orgs/telco/memos/hosttable/{hosttable}?limit='100'&offset='100'&create-from='2020-01-01'&create-to='2020-12-31' \
-H "Accept: application/json" \
-H "x-auth-roles: API_KEY"
|
Parameters
Name |
In |
Type |
Required |
Description |
orgId |
path |
string |
true |
organization name |
customerId |
path |
integer(int64) |
true |
customer identifier |
limit |
query |
integer(int64) |
false |
Limit the elements numbers in response |
offset |
query |
integer(int64) |
false |
Move the pointer to the first element in response |
create-from |
query |
string(date) |
false |
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01 |
create-to |
query |
string(date) |
false |
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01 |
Request example
1
2
3
4
5
|
curl -X GET https://customers.sta.masstack.com/v3/orgs/telco/memos/customers/214748364?limit='100'&offset='100'&create-from='2020-01-01'&create-to='2020-12-31' \
-H "Accept: application/json" \
-H "x-auth-roles: API_KEY"
|
Parameters
Name |
In |
Type |
Required |
Description |
orgId |
path |
string |
true |
organization name |
hosttable |
path |
string |
true |
Name of table where this memo record is assignedSee HostTable. |
customerId |
path |
integer(int64) |
true |
customer identifier |
limit |
query |
integer(int64) |
false |
Limit the elements numbers in response |
offset |
query |
integer(int64) |
false |
Move the pointer to the first element in response |
create-from |
query |
string(date) |
false |
start date query against createStamp column, with format yyyy-mm-dd, for example 2020-01-01 |
create-to |
query |
string(date) |
false |
end date query against createStamp column with format yyyy-mm-dd, for example 2020-01-01 |
Request example
1
2
3
4
5
|
curl -X GET https://customers.sta.masstack.com/v3/orgs/telco/memos/hosttable/{hosttable}/customers/214748364?limit='100'&offset='100'&create-from='2020-01-01'&create-to='2020-12-31' \
-H "Accept: application/json" \
-H "x-auth-roles: API_KEY"
|